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

Class WebSocketSettings

java.lang.Object

org.apache.pekko.http.scaladsl.settings.WebSocketSettings

All Implemented Interfaces:

WebSocketSettings

Direct Known Subclasses:

WebSocketSettingsImpl

public abstract class WebSocketSettings
extends Object
implements WebSocketSettings

Constructor Summary

Constructors

Constructor	Description
WebSocketSettings()

Method Summary

Modifier and Type	Method	Description
final Supplier<org.apache.pekko.util.ByteString>	getPeriodicKeepAliveData()	The provided supplier will be invoked for each new keep-alive frame that is sent.
final Supplier<Random>	getRandomFactory()
abstract boolean	logFrames()
abstract scala.Function0<org.apache.pekko.util.ByteString>	periodicKeepAliveData()	The provided function will be invoked for each new keep-alive frame that is sent.
abstract scala.concurrent.duration.Duration	periodicKeepAliveMaxIdle()
abstract String	periodicKeepAliveMode()
abstract scala.Function0<Random>	randomFactory()
WebSocketSettings	withLogFrames(boolean shouldLog)
WebSocketSettings	withPeriodicKeepAliveData(scala.Function0<org.apache.pekko.util.ByteString> newValue)
WebSocketSettings	withPeriodicKeepAliveMaxIdle(scala.concurrent.duration.Duration newValue)
WebSocketSettings	withPeriodicKeepAliveMode(String newValue)
WebSocketSettings	withRandomFactoryFactory(Supplier<Random> newValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pekko.http.javadsl.settings.WebSocketSettings

getPeriodicKeepAliveMaxIdle, withPeriodicKeepAliveData, withPeriodicKeepAliveMaxIdle

Constructor Details

WebSocketSettings

public WebSocketSettings()

Method Details

getPeriodicKeepAliveData

public final Supplier<org.apache.pekko.util.ByteString> getPeriodicKeepAliveData()

Description copied from interface: WebSocketSettings

The provided supplier will be invoked for each new keep-alive frame that is sent. The ByteString will be included in the Ping or Pong frame sent as heartbeat, so keep in mind to keep it relatively small, in order not to make the frames too bloated.

Specified by:

getPeriodicKeepAliveData in interface WebSocketSettings

Returns:

(undocumented)

getRandomFactory

public final Supplier<Random> getRandomFactory()

Specified by:

getRandomFactory in interface WebSocketSettings

logFrames

public abstract boolean logFrames()

Specified by:

logFrames in interface WebSocketSettings

periodicKeepAliveData

public abstract scala.Function0<org.apache.pekko.util.ByteString> periodicKeepAliveData()

The provided function will be invoked for each new keep-alive frame that is sent. The ByteString will be included in the Ping or Pong frame sent as heartbeat, so keep in mind to keep it relatively small, in order not to make the frames too bloated.

Returns:

(undocumented)

periodicKeepAliveMaxIdle

public abstract scala.concurrent.duration.Duration periodicKeepAliveMaxIdle()

Specified by:

periodicKeepAliveMaxIdle in interface WebSocketSettings

periodicKeepAliveMode

public abstract String periodicKeepAliveMode()

Specified by:

periodicKeepAliveMode in interface WebSocketSettings

randomFactory

public abstract scala.Function0<Random> randomFactory()

withLogFrames

public WebSocketSettings withLogFrames(boolean shouldLog)

Specified by:

withLogFrames in interface WebSocketSettings

withPeriodicKeepAliveData

public WebSocketSettings withPeriodicKeepAliveData(scala.Function0<org.apache.pekko.util.ByteString> newValue)

withPeriodicKeepAliveMaxIdle

public WebSocketSettings withPeriodicKeepAliveMaxIdle(scala.concurrent.duration.Duration newValue)

Specified by:

withPeriodicKeepAliveMaxIdle in interface WebSocketSettings

withPeriodicKeepAliveMode

public WebSocketSettings withPeriodicKeepAliveMode(String newValue)

Specified by:

withPeriodicKeepAliveMode in interface WebSocketSettings

withRandomFactoryFactory

public WebSocketSettings withRandomFactoryFactory(Supplier<Random> newValue)

Specified by:

withRandomFactoryFactory in interface WebSocketSettings