org.apache.pekko.http.scaladsl.unmarshalling.sse

Interface EventStreamUnmarshalling

All Known Implementing Classes:

EventStreamUnmarshalling$

public interface EventStreamUnmarshalling

Mixing in this trait lets a HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.

The maximum size for parsing server-sent events is 8KiB by default and can be customized by configuring pekko.http.sse.max-event-size. The maximum size for parsing lines of a server-sent event is 4KiB by default and can be customized by configuring pekko.http.sse.max-line-size.

Method Summary

Modifier and Type	Method and Description
Unmarshaller<HttpEntity,org.apache.pekko.stream.scaladsl.Source<ServerSentEvent,org.apache.pekko.NotUsed>>	fromEventsStream(org.apache.pekko.actor.ActorSystem system) Lets an HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.
Unmarshaller<HttpEntity,org.apache.pekko.stream.scaladsl.Source<ServerSentEvent,org.apache.pekko.NotUsed>>	fromEventsStream(int maxLineSize, int maxEventSize, boolean emitEmptyEvents)
Unmarshaller<HttpEntity,org.apache.pekko.stream.scaladsl.Source<ServerSentEvent,org.apache.pekko.NotUsed>>	fromEventsStream(ServerSentEventSettings settings) Lets an HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.
Unmarshaller<HttpEntity,org.apache.pekko.stream.scaladsl.Source<ServerSentEvent,org.apache.pekko.NotUsed>>	fromEventStream() Deprecated. Binary compatibility method. Invocations should have an implicit ActorSystem in scope to provide access to configuration. Since Akka HTTP 10.1.8.
int	maxEventSize() Deprecated. Set this property in configuration as `pekko.http.sse.max-event-size` before calling fromEventsStream(implicit ActorSystem). Since Akka HTTP 10.1.8.
int	maxLineSize() Deprecated. Set this property in configuration as `pekko.http.sse.max-line-size` before calling fromEventsStream(implicit ActorSystem). Since Akka HTTP 10.1.8.

Method Detail

maxLineSize

int maxLineSize()

Deprecated. Set this property in configuration as `pekko.http.sse.max-line-size` before calling fromEventsStream(implicit ActorSystem). Since Akka HTTP 10.1.8.

The maximum size for parsing lines of a server-sent event; 4KiB by default.

Returns:

(undocumented)

maxEventSize

int maxEventSize()

Deprecated. Set this property in configuration as `pekko.http.sse.max-event-size` before calling fromEventsStream(implicit ActorSystem). Since Akka HTTP 10.1.8.

The maximum size for parsing server-sent events; 8KiB by default.

Returns:

(undocumented)

fromEventStream

Unmarshaller<HttpEntity,org.apache.pekko.stream.scaladsl.Source<ServerSentEvent,org.apache.pekko.NotUsed>> fromEventStream()

Deprecated. Binary compatibility method. Invocations should have an implicit ActorSystem in scope to provide access to configuration. Since Akka HTTP 10.1.8.

fromEventsStream

Unmarshaller<HttpEntity,org.apache.pekko.stream.scaladsl.Source<ServerSentEvent,org.apache.pekko.NotUsed>> fromEventsStream(org.apache.pekko.actor.ActorSystem system)

Lets an HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.

Parameters:

system - (undocumented)

Returns:

(undocumented)

fromEventsStream

Unmarshaller<HttpEntity,org.apache.pekko.stream.scaladsl.Source<ServerSentEvent,org.apache.pekko.NotUsed>> fromEventsStream(ServerSentEventSettings settings)

Lets an HttpEntity with a text/event-stream media type be unmarshalled to a source of ServerSentEvents.

Parameters:

settings - overrides the default unmarshalling behavior.

Returns:

(undocumented)

fromEventsStream

Unmarshaller<HttpEntity,org.apache.pekko.stream.scaladsl.Source<ServerSentEvent,org.apache.pekko.NotUsed>> fromEventsStream(int maxLineSize,
                                                                                                                            int maxEventSize,
                                                                                                                            boolean emitEmptyEvents)