Safe Haskell	None
Language	Haskell2010

Servant.API.EventStream

Synopsis

data ServerSentEvents
data EventStream
type EventSource = SourceIO ServerEvent
type EventSourceHdr = Headers '[Header "X-Accel-Buffering" Text] EventSource
eventSource :: Proxy X () () ServerEvent IO () -> EventSourceHdr
jsForAPI :: (HasForeign NoTypes NoContent api, GenerateList NoContent (Foreign NoContent api)) => Proxy api -> Text

Documentation

data ServerSentEvents Source #

Instances

Instances details

Generic ServerSentEvents Source #
Instance details Defined in Servant.API.EventStream Associated Types type Rep ServerSentEvents :: Type -> Type # Methods from :: ServerSentEvents -> Rep ServerSentEvents x # to :: Rep ServerSentEvents x -> ServerSentEvents #
HasForeignType lang ftype EventSourceHdr => HasForeign (lang :: k) ftype ServerSentEvents Source #	a helper instance for servant-foreign
Instance details Defined in Servant.API.EventStream Associated Types type Foreign ftype ServerSentEvents # Methods foreignFor :: Proxy lang -> Proxy ftype -> Proxy ServerSentEvents -> Req ftype -> Foreign ftype ServerSentEvents #
HasLink ServerSentEvents Source #
Instance details Defined in Servant.API.EventStream Associated Types type MkLink ServerSentEvents a # Methods toLink :: (Link -> a) -> Proxy ServerSentEvents -> Link -> MkLink ServerSentEvents a #
HasServer ServerSentEvents context Source #
Instance details Defined in Servant.API.EventStream Associated Types type ServerT ServerSentEvents m # Methods route :: Proxy ServerSentEvents -> Context context -> Delayed env (Server ServerSentEvents) -> Router env # hoistServerWithContext :: Proxy ServerSentEvents -> Proxy context -> (forall x. m x -> n x) -> ServerT ServerSentEvents m -> ServerT ServerSentEvents n #
type Rep ServerSentEvents Source #
Instance details Defined in Servant.API.EventStream type Rep ServerSentEvents = D1 ('MetaData "ServerSentEvents" "Servant.API.EventStream" "servant-event-stream-0.2.1.0-inplace" 'True) (C1 ('MetaCons "ServerSentEvents" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StreamGet NoFraming EventStream EventSourceHdr))))
type Foreign ftype ServerSentEvents Source #
Instance details Defined in Servant.API.EventStream type Foreign ftype ServerSentEvents = Req ftype
type MkLink ServerSentEvents a Source #
Instance details Defined in Servant.API.EventStream type MkLink ServerSentEvents a = MkLink (StreamGet NoFraming EventStream EventSourceHdr) a
type ServerT ServerSentEvents m Source #
Instance details Defined in Servant.API.EventStream type ServerT ServerSentEvents m = ServerT (StreamGet NoFraming EventStream EventSourceHdr) m

data EventStream Source #

A type representation of an event stream. It's responsible for setting proper content-type and buffering headers, as well as for providing parser implementations for the streams. Read more on Servant Streaming Docs

Instances

Instances details

Accept EventStream Source #
Instance details Defined in Servant.API.EventStream Methods contentType :: Proxy EventStream -> MediaType # contentTypes :: Proxy EventStream -> NonEmpty MediaType #
MimeRender EventStream ServerEvent Source #	See details at https://hackage.haskell.org/package/wai-extra-3.1.6/docs/Network-Wai-EventSource-EventStream.html#v:eventToBuilder
Instance details Defined in Servant.API.EventStream Methods mimeRender :: Proxy EventStream -> ServerEvent -> ByteString #

type EventSource = SourceIO ServerEvent Source #

type EventSourceHdr = Headers '[Header "X-Accel-Buffering" Text] EventSource Source #

This is mostly to guide reverse-proxies like nginx

eventSource :: Proxy X () () ServerEvent IO () -> EventSourceHdr Source #

jsForAPI :: (HasForeign NoTypes NoContent api, GenerateList NoContent (Foreign NoContent api)) => Proxy api -> Text Source #