Package org.apache.pekko.http.scaladsl.settings

Class ServerSentEventSettings

java.lang.Object

org.apache.pekko.http.javadsl.settings.ServerSentEventSettings

org.apache.pekko.http.scaladsl.settings.ServerSentEventSettings

Direct Known Subclasses:

ServerSentEventSettingsImpl

public abstract class ServerSentEventSettings
extends ServerSentEventSettings

Public API but not intended for subclassing

Options that are in "preview" or "early access" mode. These options may change and/or be removed within patch releases without early notice (e.g. by moving them into a stable supported place).

Constructor Summary

Constructors

Constructor	Description
ServerSentEventSettings()

Method Summary

Modifier and Type	Method	Description
static ServerSentEventSettings	apply(com.typesafe.config.Config config)
static ServerSentEventSettings	apply(String configOverrides)
static ServerSentEventSettings	fromSubConfig(com.typesafe.config.Config root, com.typesafe.config.Config c)
abstract int	maxEventSize()	The maximum size for parsing server-sent events
abstract int	maxLineSize()	The maximum size for parsing lines of a server-sent event
OversizedSseStrategy	oversizedEventStrategy()
OversizedSseStrategy	oversizedLineStrategy()
ServerSentEventSettings	withEmitEmptyEvents(boolean newValue)
ServerSentEventSettings	withLineLength(int newValue)
ServerSentEventSettings	withMaxEventSize(int newValue)
ServerSentEventSettings	withOversizedEventStrategy(String newValue)
ServerSentEventSettings	withOversizedEventStrategy(OversizedSseStrategy newValue)
ServerSentEventSettings	withOversizedLineStrategy(String newValue)
ServerSentEventSettings	withOversizedLineStrategy(OversizedSseStrategy newValue)

Methods inherited from class org.apache.pekko.http.javadsl.settings.ServerSentEventSettings

create, create, create, emitEmptyEvents, getOversizedEventStrategy, getOversizedEventStrategyEnum, getOversizedLineStrategy, getOversizedLineStrategyEnum, withOversizedEventStrategy, withOversizedLineStrategy

Methods inherited from class java.lang.Object

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

Constructor Details

ServerSentEventSettings

public ServerSentEventSettings()

Method Details

fromSubConfig

public static ServerSentEventSettings fromSubConfig(com.typesafe.config.Config root,
 com.typesafe.config.Config c)

apply

public static ServerSentEventSettings apply(com.typesafe.config.Config config)

apply

public static ServerSentEventSettings apply(String configOverrides)

maxEventSize

public abstract int maxEventSize()

Description copied from class: ServerSentEventSettings

The maximum size for parsing server-sent events

Specified by:

maxEventSize in class ServerSentEventSettings

Returns:

(undocumented)

maxLineSize

public abstract int maxLineSize()

Description copied from class: ServerSentEventSettings

The maximum size for parsing lines of a server-sent event

Specified by:

maxLineSize in class ServerSentEventSettings

Returns:

(undocumented)

oversizedLineStrategy

public OversizedSseStrategy oversizedLineStrategy()

Returns:

(undocumented)

Since:

1.3.0

oversizedEventStrategy

public OversizedSseStrategy oversizedEventStrategy()

Returns:

(undocumented)

Since:

1.3.0

withMaxEventSize

public ServerSentEventSettings withMaxEventSize(int newValue)

Overrides:

withMaxEventSize in class ServerSentEventSettings

withLineLength

public ServerSentEventSettings withLineLength(int newValue)

Overrides:

withLineLength in class ServerSentEventSettings

withEmitEmptyEvents

public ServerSentEventSettings withEmitEmptyEvents(boolean newValue)

Overrides:

withEmitEmptyEvents in class ServerSentEventSettings

withOversizedLineStrategy

public ServerSentEventSettings withOversizedLineStrategy(String newValue)

Overrides:

withOversizedLineStrategy in class ServerSentEventSettings

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

Since:

1.3.0

withOversizedLineStrategy

public ServerSentEventSettings withOversizedLineStrategy(OversizedSseStrategy newValue)

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

Since:

1.3.0

withOversizedEventStrategy

public ServerSentEventSettings withOversizedEventStrategy(String newValue)

Overrides:

withOversizedEventStrategy in class ServerSentEventSettings

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

Since:

1.3.0

withOversizedEventStrategy

public ServerSentEventSettings withOversizedEventStrategy(OversizedSseStrategy newValue)

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

Since:

1.3.0