Moduleservant-client-core-0.20.3.0Haskell2010

Servant.Client.Core.ServerSentEvents

Server-sent events

See https://www.w3.org/TR/2009/WD-eventsource-20090421/ for more details on server-sent events (SSE).

Synopsis

data EventMessage
data EventIgnoreReason
data Event
newtype EventStreamT
newtype JsonEventStreamT
newtype EventMessageStreamT

Packageservant-client-core-0.20.3.0
Exports6
LanguageHaskell2010
LicenceBSD-3-Clause
SourceServerSentEvents.hs

datadata EventMessage

Source#

Structured variant of an event line of an event stream

Constructors

EventDispatch
Dispatch on the accumulated event.
EventSetName ByteString
Set the name of the current event.
EventSetLastId ByteString
Set the last event identifier.
EventData ByteString
Append data to the event's data buffer.
EventRetry Natural
Set the event stream's reconnection time.
EventIgnore EventIgnoreReason
Ignored

Instances5Eq, Ord, Show, HasClient, Client

Eq EventMessageDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Ord EventMessageDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Show EventMessageDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
(RunClient m, HasClient m (SseClientDelegate method status (EventMessageStreamT IO))) => HasClient m (ServerSentEvents' method status 'RawEvent EventMessage)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.HasClient
type Client m (ServerSentEvents' method status 'RawEvent EventMessage) = Client m (SseClientDelegate method status (EventMessageStreamT IO))Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.HasClient

datadata EventIgnoreReason

Source#

Reason why a event line can be ignored

Constructors

EventFieldNameUnknown ByteString
EventRetryNonNumeric ByteString
EventComment ByteString

Instances3Eq, Ord, Show

Eq EventIgnoreReasonDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Ord EventIgnoreReasonDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Show EventIgnoreReasonDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents

datadata Event a

Source#

Event sent by the remote

Constructors

Event
- eventName :: Maybe ByteString
- eventData :: a

Instances8Functor, HasClient, Eq, Ord, Show, Generic, …

Functor EventDefined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
(RunClient m, HasClient m (SseClientDelegate method status (EventStreamT IO))) => HasClient m (ServerSentEvents' method status 'RawEvent (Event a))Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.HasClient
Eq a => Eq (Event a)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Ord a => Ord (Event a)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Show a => Show (Event a)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Generic (Event a)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
type Rep (Event a) = D1 ('MetaData "Event" "Servant.Client.Core.ServerSentEvents" "servant-client-core-0.20.3.0-FItKzh2sH3dBXhimfAbuJR" 'False) (C1 ('MetaCons "Event" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "eventData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a)))Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
type Client m (ServerSentEvents' method status 'RawEvent (Event a)) = Client m (SseClientDelegate method status (EventStreamT IO))Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.HasClient

newtypenewtype EventStreamT (m :: Type -> Type)

Source#

Server-sent event stream (SSE)

See https://www.w3.org/TR/2009/WD-eventsource-20090421/ for more details.

Constructors

EventStreamT
- unEventStreamT :: SourceT m (Event ByteString)

Instances4FromSourceIO, Show, Semigroup, Monoid

MonadIO m => FromSourceIO EventStreamChunk (EventStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Server-sent events
(Applicative m, Show1 m) => Show (EventStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Functor m => Semigroup (EventStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Functor m => Monoid (EventStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents

newtypenewtype JsonEventStreamT (m :: Type -> Type) a

Source#

Server-sent event stream (SSE) for JSON values

Constructors

JsonEventStreamT
- unJsonEventStreamT :: SourceT m (Event a)

Instances5FromSourceIO, Functor, Show, Semigroup, Monoid

(MonadIO m, FromJSON a) => FromSourceIO EventStreamChunk (JsonEventStreamT m a)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Server-sent JSON event stream
Functor m => Functor (JsonEventStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
(Applicative m, Show1 m, Show a) => Show (JsonEventStreamT m a)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Functor m => Semigroup (JsonEventStreamT m a)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Functor m => Monoid (JsonEventStreamT m a)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents

newtypenewtype EventMessageStreamT (m :: Type -> Type)

Source#

Server-sent event stream (SSE)

See https://www.w3.org/TR/2009/WD-eventsource-20090421/ for more details.

Constructors

EventMessageStreamT
- unEventMessageStreamT :: SourceT m EventMessage

Instances4FromSourceIO, Show, Semigroup, Monoid

MonadIO m => FromSourceIO EventStreamChunk (EventMessageStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Server-sent event messages
EventMessage gives you more control over the communication with the server than Event.
(Applicative m, Show1 m) => Show (EventMessageStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Functor m => Semigroup (EventMessageStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents
Functor m => Monoid (EventMessageStreamT m)Defined in servant-client-core-0.20.3.0 · Servant.Client.Core.ServerSentEvents