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

Class EventStreamParser

java.lang.Object

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

public class EventStreamParser
extends java.lang.Object

Flow that converts raw byte string input into ServerSentEvents.

This API is made for use in non-pekko-http clients, like Play's WSClient.

Constructor Summary

Constructors

Constructor and Description
EventStreamParser()

Method Summary

Modifier and Type	Method and Description
static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed>	apply(int maxLineSize, int maxEventSize) Flow that converts raw byte string input into ServerSentEvents.
static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed>	apply(int maxLineSize, int maxEventSize, boolean emitEmptyEvents) Flow that converts raw byte string input into ServerSentEvents.
static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed>	apply(int maxLineSize, int maxEventSize, boolean emitEmptyEvents, OversizedSseStrategy oversizedStrategy) Flow that converts raw byte string input into ServerSentEvents.
static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed>	apply(int maxLineSize, int maxEventSize, boolean emitEmptyEvents, OversizedSseStrategy oversizedLineStrategy, OversizedSseStrategy oversizedEventStrategy) Flow that converts raw byte string input into ServerSentEvents.
static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed>	apply(int maxLineSize, int maxEventSize, boolean emitEmptyEvents, java.lang.String oversizedStrategy) Flow that converts raw byte string input into ServerSentEvents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventStreamParser

public EventStreamParser()

Method Detail

apply

public static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed> apply(int maxLineSize,
                                                                                                                                     int maxEventSize)

Flow that converts raw byte string input into ServerSentEvents.

This API is made for use in non-pekko-http clients, like Play's WSClient.

Parameters:

maxLineSize - The maximum size of a line for the event Stream parser

maxEventSize - The maximum size of a server-sent event for the event Stream parser

Returns:

(undocumented)

apply

public static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed> apply(int maxLineSize,
                                                                                                                                     int maxEventSize,
                                                                                                                                     boolean emitEmptyEvents)

Flow that converts raw byte string input into ServerSentEvents.

This API is made for use in non-pekko-http clients, like Play's WSClient.

Parameters:

maxLineSize - The maximum size of a line for the event Stream parser

maxEventSize - The maximum size of a server-sent event for the event Stream parser

emitEmptyEvents - Should the parser emit events with empty data field

Returns:

(undocumented)

apply

public static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed> apply(int maxLineSize,
                                                                                                                                     int maxEventSize,
                                                                                                                                     boolean emitEmptyEvents,
                                                                                                                                     java.lang.String oversizedStrategy)

Flow that converts raw byte string input into ServerSentEvents.

This API is made for use in non-pekko-http clients, like Play's WSClient.

Parameters:

maxLineSize - The maximum size of a line for the event Stream parser

maxEventSize - The maximum size of a server-sent event for the event Stream parser

emitEmptyEvents - Should the parser emit events with empty data field

oversizedStrategy - How to handle messages that exceed max-line-size

Returns:

(undocumented)

Since:

1.3.0

apply

public static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed> apply(int maxLineSize,
                                                                                                                                     int maxEventSize,
                                                                                                                                     boolean emitEmptyEvents,
                                                                                                                                     OversizedSseStrategy oversizedStrategy)

Flow that converts raw byte string input into ServerSentEvents.

This API is made for use in non-pekko-http clients, like Play's WSClient.

Parameters:

maxLineSize - The maximum size of a line for the event Stream parser

maxEventSize - The maximum size of a server-sent event for the event Stream parser

emitEmptyEvents - Should the parser emit events with empty data field

oversizedStrategy - How to handle messages that exceed max-line-size and max-event-size

Returns:

(undocumented)

Since:

1.3.0

apply

public static org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,ServerSentEvent,org.apache.pekko.NotUsed> apply(int maxLineSize,
                                                                                                                                     int maxEventSize,
                                                                                                                                     boolean emitEmptyEvents,
                                                                                                                                     OversizedSseStrategy oversizedLineStrategy,
                                                                                                                                     OversizedSseStrategy oversizedEventStrategy)

Flow that converts raw byte string input into ServerSentEvents.

This API is made for use in non-pekko-http clients, like Play's WSClient.

Parameters:

maxLineSize - The maximum size of a line for the event Stream parser

maxEventSize - The maximum size of a server-sent event for the event Stream parser

emitEmptyEvents - Should the parser emit events with empty data field

oversizedLineStrategy - How to handle lines that exceed max-line-size

oversizedEventStrategy - How to handle events that exceed max-event-size

Returns:

(undocumented)

Since:

1.3.0