Package akka.http.scaladsl.settings
Class WebSocketSettings
java.lang.Object
akka.http.scaladsl.settings.WebSocketSettings
- All Implemented Interfaces:
WebSocketSettings
- Direct Known Subclasses:
WebSocketSettingsImpl
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Supplier<akka.util.ByteString>
The provided supplier will be invoked for each new keep-alive frame that is sent.abstract boolean
abstract scala.Function0<akka.util.ByteString>
The provided function will be invoked for each new keep-alive frame that is sent.abstract scala.concurrent.duration.Duration
abstract String
abstract scala.Function0<Random>
withLogFrames
(boolean shouldLog) withPeriodicKeepAliveData
(scala.Function0<akka.util.ByteString> newValue) withPeriodicKeepAliveMaxIdle
(scala.concurrent.duration.Duration newValue) withPeriodicKeepAliveMode
(String newValue) 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 akka.http.javadsl.settings.WebSocketSettings
withPeriodicKeepAliveData
-
Constructor Details
-
WebSocketSettings
public WebSocketSettings()
-
-
Method Details
-
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 interfaceWebSocketSettings
- Returns:
- (undocumented)
-
getRandomFactory
- Specified by:
getRandomFactory
in interfaceWebSocketSettings
-
logFrames
public abstract boolean logFrames()- Specified by:
logFrames
in interfaceWebSocketSettings
-
periodicKeepAliveData
public abstract scala.Function0<akka.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 interfaceWebSocketSettings
-
periodicKeepAliveMode
- Specified by:
periodicKeepAliveMode
in interfaceWebSocketSettings
-
randomFactory
-
withLogFrames
- Specified by:
withLogFrames
in interfaceWebSocketSettings
-
withPeriodicKeepAliveData
-
withPeriodicKeepAliveMaxIdle
- Specified by:
withPeriodicKeepAliveMaxIdle
in interfaceWebSocketSettings
-
withPeriodicKeepAliveMode
- Specified by:
withPeriodicKeepAliveMode
in interfaceWebSocketSettings
-
withRandomFactoryFactory
- Specified by:
withRandomFactoryFactory
in interfaceWebSocketSettings
-