Safe Haskell	Safe-Inferred
Language	Haskell2010

Hercules.API.Agent.Socket.Frame

Synopsis

data Frame o a
- = Msg {
  - n :: Integer
  - p :: a
  }
- | Oob {
  - o :: o
  }
- | Ack {
  - n :: Integer
  }
- | Exception {
  - message :: Text
  }
mapOob :: (a -> b) -> Frame a c -> Frame b c
removeOob :: Alternative f => Frame o a -> f (Frame Void a)

Documentation

data Frame o a Source #

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

Instances details

(FromJSON a, FromJSON o) => FromJSON (Frame o a) Source #
Instance details Defined in Hercules.API.Agent.Socket.Frame Methods parseJSON :: Value -> Parser (Frame o a) Source # parseJSONList :: Value -> Parser [Frame o a] Source #
(ToJSON o, ToJSON a) => ToJSON (Frame o a) Source #
Instance details Defined in Hercules.API.Agent.Socket.Frame Methods toJSON :: Frame o a -> Value Source # toEncoding :: Frame o a -> Encoding Source # toJSONList :: [Frame o a] -> Value Source # toEncodingList :: [Frame o a] -> Encoding Source #
Generic (Frame o a) Source #
Instance details Defined in Hercules.API.Agent.Socket.Frame Associated Types type Rep (Frame o a) :: Type -> Type Source # Methods from :: Frame o a -> Rep (Frame o a) x Source # to :: Rep (Frame o a) x -> Frame o a Source #
(Show a, Show o) => Show (Frame o a) Source #
Instance details Defined in Hercules.API.Agent.Socket.Frame Methods showsPrec :: Int -> Frame o a -> ShowS Source # show :: Frame o a -> String Source # showList :: [Frame o a] -> ShowS Source #
(NFData a, NFData o) => NFData (Frame o a) Source #
Instance details Defined in Hercules.API.Agent.Socket.Frame Methods rnf :: Frame o a -> () Source #
(Eq a, Eq o) => Eq (Frame o a) Source #
Instance details Defined in Hercules.API.Agent.Socket.Frame Methods (==) :: Frame o a -> Frame o a -> Bool Source # (/=) :: Frame o a -> Frame o a -> Bool Source #
type Rep (Frame o a) Source #
Instance details 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.1-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 Source #

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