Package akka.http.javadsl.settings
Interface WebSocketSettings
-
- All Known Implementing Classes:
WebSocketSettings
,WebSocketSettingsImpl
public interface WebSocketSettings
Public API but not intended for subclassing
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.function.Supplier<akka.util.ByteString>
getPeriodicKeepAliveData()
The provided supplier will be invoked for each new keep-alive frame that is sent.java.util.function.Supplier<java.util.Random>
getRandomFactory()
boolean
logFrames()
scala.concurrent.duration.Duration
periodicKeepAliveMaxIdle()
java.lang.String
periodicKeepAliveMode()
scala.concurrent.duration.Duration
receiveIdleTimeout()
scala.concurrent.duration.Duration
sendIdleTimeout()
WebSocketSettings
withLogFrames(boolean shouldLog)
WebSocketSettings
withPeriodicKeepAliveData(java.util.function.Supplier<akka.util.ByteString> newValue)
WebSocketSettings
withPeriodicKeepAliveMaxIdle(scala.concurrent.duration.Duration newValue)
WebSocketSettings
withPeriodicKeepAliveMode(java.lang.String newValue)
WebSocketSettings
withRandomFactoryFactory(java.util.function.Supplier<java.util.Random> newValue)
-
-
-
Method Detail
-
getRandomFactory
java.util.function.Supplier<java.util.Random> getRandomFactory()
-
receiveIdleTimeout
scala.concurrent.duration.Duration receiveIdleTimeout()
-
sendIdleTimeout
scala.concurrent.duration.Duration sendIdleTimeout()
-
periodicKeepAliveMode
java.lang.String periodicKeepAliveMode()
-
periodicKeepAliveMaxIdle
scala.concurrent.duration.Duration periodicKeepAliveMaxIdle()
-
getPeriodicKeepAliveData
java.util.function.Supplier<akka.util.ByteString> getPeriodicKeepAliveData()
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.- Returns:
- (undocumented)
-
withRandomFactoryFactory
WebSocketSettings withRandomFactoryFactory(java.util.function.Supplier<java.util.Random> newValue)
-
withPeriodicKeepAliveMode
WebSocketSettings withPeriodicKeepAliveMode(java.lang.String newValue)
-
withPeriodicKeepAliveMaxIdle
WebSocketSettings withPeriodicKeepAliveMaxIdle(scala.concurrent.duration.Duration newValue)
-
withPeriodicKeepAliveData
WebSocketSettings withPeriodicKeepAliveData(java.util.function.Supplier<akka.util.ByteString> newValue)
-
logFrames
boolean logFrames()
-
withLogFrames
WebSocketSettings withLogFrames(boolean shouldLog)
-
-