Hercules.API.Agent.Socket.Frame

Documentation

data Frame o a

Adds serial number n to payloads p and allows acknowledgement for a related stream that travels in the opposite direction.

Constructors

Msg

Message

Fields

• n :: Integer
• p :: a

Oob

Out of band message: not redelivered, not acknowledged.

Fields

• o :: o

Ack

Acknowledgement

Fields

• n :: Integer

Exception

Exception

Fields

• message :: Text

Instances

(FromJSON a, FromJSON o) => FromJSON (Frame o a)

Defined in Hercules.API.Agent.Socket.Frame

Methods

parseJSON :: Value -> Parser (Frame o a)

parseJSONList :: Value -> Parser [Frame o a]

(ToJSON o, ToJSON a) => ToJSON (Frame o a)

Defined in Hercules.API.Agent.Socket.Frame

Methods

toJSON :: Frame o a -> Value

toEncoding :: Frame o a -> Encoding

toJSONList :: [Frame o a] -> Value

toEncodingList :: [Frame o a] -> Encoding

Generic (Frame o a)

Defined in Hercules.API.Agent.Socket.Frame

Associated Types

type Rep (Frame o a) :: Type -> Type

Methods

from :: Frame o a -> Rep (Frame o a) x

to :: Rep (Frame o a) x -> Frame o a

(Show a, Show o) => Show (Frame o a)

Defined in Hercules.API.Agent.Socket.Frame

Methods

showsPrec :: Int -> Frame o a -> ShowS

show :: Frame o a -> String

showList :: [Frame o a] -> ShowS

(NFData a, NFData o) => NFData (Frame o a)

Defined in Hercules.API.Agent.Socket.Frame

Methods

rnf :: Frame o a -> ()

(Eq a, Eq o) => Eq (Frame o a)

Defined in Hercules.API.Agent.Socket.Frame

Methods

(==) :: Frame o a -> Frame o a -> Bool

(/=) :: Frame o a -> Frame o a -> Bool

type Rep (Frame o a)

Defined in Hercules.API.Agent.Socket.Frame

type Rep (Frame o a) = D1 ('MetaData "Frame" "Hercules.API.Agent.Socket.Frame" "hercules-ci-api-agent-0.5.0.0-inplace" 'False) ((C1 ('MetaCons "Msg" 'PrefixI 'True) (S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "p") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "Oob" 'PrefixI 'True) (S1 ('MetaSel ('Just "o") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 o))) :+: (C1 ('MetaCons "Ack" 'PrefixI 'True) (S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :+: C1 ('MetaCons "Exception" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

mapOob :: (a -> b) -> Frame a c -> Frame b c

removeOob :: Alternative f => Frame o a -> f (Frame Void a)