Package org.apache.pekko.http.impl.settings

Class WebSocketSettingsImpl

java.lang.Object

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

org.apache.pekko.http.impl.settings.WebSocketSettingsImpl

All Implemented Interfaces:

Serializable, WebSocketSettings, scala.Equals, scala.Product

public final class WebSocketSettingsImpl
extends WebSocketSettings
implements scala.Product, Serializable

INTERNAL API

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebSocketSettingsImpl(scala.Function0<Random> randomFactory, String periodicKeepAliveMode, scala.concurrent.duration.Duration periodicKeepAliveMaxIdle, scala.Function0<org.apache.pekko.util.ByteString> periodicKeepAliveData, boolean logFrames)

Method Summary

Modifier and Type	Method	Description
static WebSocketSettingsImpl	client(com.typesafe.config.Config config)
static WebSocketSettingsImpl	clientFromRoot(com.typesafe.config.Config root)
Duration	getPeriodicKeepAliveMaxIdle()	Java API
static boolean	hasNoCustomPeriodicKeepAliveData(WebSocketSettings settings)
boolean	logFrames()
scala.Function0<org.apache.pekko.util.ByteString>	periodicKeepAliveData()	The provided function will be invoked for each new keep-alive frame that is sent.
scala.concurrent.duration.Duration	periodicKeepAliveMaxIdle()
String	periodicKeepAliveMode()
String	productPrefix()
scala.Function0<Random>	randomFactory()
static WebSocketSettingsImpl	server(com.typesafe.config.Config config)
static WebSocketSettingsImpl	serverFromRoot(com.typesafe.config.Config root)

Methods inherited from class org.apache.pekko.http.scaladsl.settings.WebSocketSettings

getPeriodicKeepAliveData, getRandomFactory, withLogFrames, withPeriodicKeepAliveData, withPeriodicKeepAliveMaxIdle, withPeriodicKeepAliveMode, withRandomFactoryFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator

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

withPeriodicKeepAliveData, withPeriodicKeepAliveMaxIdle

Constructor Details

WebSocketSettingsImpl

public WebSocketSettingsImpl(scala.Function0<Random> randomFactory,
 String periodicKeepAliveMode,
 scala.concurrent.duration.Duration periodicKeepAliveMaxIdle,
 scala.Function0<org.apache.pekko.util.ByteString> periodicKeepAliveData,
 boolean logFrames)

Method Details

hasNoCustomPeriodicKeepAliveData

public static boolean hasNoCustomPeriodicKeepAliveData(WebSocketSettings settings)

serverFromRoot

public static WebSocketSettingsImpl serverFromRoot(com.typesafe.config.Config root)

server

public static WebSocketSettingsImpl server(com.typesafe.config.Config config)

clientFromRoot

public static WebSocketSettingsImpl clientFromRoot(com.typesafe.config.Config root)

client

public static WebSocketSettingsImpl client(com.typesafe.config.Config config)

randomFactory

public scala.Function0<Random> randomFactory()

Specified by:

randomFactory in class WebSocketSettings

periodicKeepAliveMode

public String periodicKeepAliveMode()

Specified by:

periodicKeepAliveMode in interface WebSocketSettings

Specified by:

periodicKeepAliveMode in class WebSocketSettings

periodicKeepAliveMaxIdle

public scala.concurrent.duration.Duration periodicKeepAliveMaxIdle()

Specified by:

periodicKeepAliveMaxIdle in interface WebSocketSettings

Specified by:

periodicKeepAliveMaxIdle in class WebSocketSettings

periodicKeepAliveData

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

Description copied from class: WebSocketSettings

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.

Specified by:

periodicKeepAliveData in class WebSocketSettings

Returns:

(undocumented)

logFrames

public boolean logFrames()

Specified by:

logFrames in interface WebSocketSettings

Specified by:

logFrames in class WebSocketSettings

getPeriodicKeepAliveMaxIdle

public Duration getPeriodicKeepAliveMaxIdle()

Description copied from interface: WebSocketSettings

Java API

Specified by:

getPeriodicKeepAliveMaxIdle in interface WebSocketSettings

Returns:

(undocumented)

productPrefix

public String productPrefix()

Specified by:

productPrefix in interface scala.Product