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
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
Accept EventStream Source # | |
Defined in Servant.API.EventStream Methods contentType :: Proxy EventStream -> 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 |
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 #