java.lang.Object
- akka.http.scaladsl.settings.WebSocketSettings

All Implemented Interfaces:: WebSocketSettings

Direct Known Subclasses:: WebSocketSettingsImpl

public abstract class WebSocketSettings
extends java.lang.Object
implements WebSocketSettings

Constructor Summary

Constructors
Constructor Description

WebSocketSettings()

Method Summary

All Methods Instance Methods Abstract Methods Concrete 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()`
`abstract boolean`	`logFrames()`
`abstract scala.Function0<akka.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 java.lang.String`	`periodicKeepAliveMode()`
`abstract scala.Function0<java.util.Random>`	`randomFactory()`
`abstract scala.concurrent.duration.Duration`	`receiveIdleTimeout()`
`abstract scala.concurrent.duration.Duration`	`sendIdleTimeout()`
`WebSocketSettings`	`withLogFrames(boolean shouldLog)`
`WebSocketSettings`	`withPeriodicKeepAliveData(scala.Function0<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)`

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 Detail
  - WebSocketSettings
```
public WebSocketSettings()
```
- Method Detail
  - getPeriodicKeepAliveData
```
public final java.util.function.Supplier<akka.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 java.util.function.Supplier<java.util.Random> getRandomFactory()
```
    Specified by:
    
    getRandomFactory in interface WebSocketSettings
  - logFrames
```
public abstract boolean logFrames()
```
    Specified by:
    
    logFrames in interface WebSocketSettings
  - 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 interface WebSocketSettings
  - periodicKeepAliveMode
```
public abstract java.lang.String periodicKeepAliveMode()
```
    Specified by:
    
    periodicKeepAliveMode in interface WebSocketSettings
  - randomFactory
```
public abstract scala.Function0<java.util.Random> randomFactory()
```
  - receiveIdleTimeout
```
public abstract scala.concurrent.duration.Duration receiveIdleTimeout()
```
    Specified by:
    
    receiveIdleTimeout in interface WebSocketSettings
  - sendIdleTimeout
```
public abstract scala.concurrent.duration.Duration sendIdleTimeout()
```
    Specified by:
    
    sendIdleTimeout in interface WebSocketSettings
  - withLogFrames
```
public WebSocketSettings withLogFrames(boolean shouldLog)
```
    Specified by:
    
    withLogFrames in interface WebSocketSettings
  - withPeriodicKeepAliveData
```
public WebSocketSettings withPeriodicKeepAliveData(scala.Function0<akka.util.ByteString> newValue)
```
  - withPeriodicKeepAliveMaxIdle
```
public WebSocketSettings withPeriodicKeepAliveMaxIdle(scala.concurrent.duration.Duration newValue)
```
    Specified by:
    
    withPeriodicKeepAliveMaxIdle in interface WebSocketSettings
  - withPeriodicKeepAliveMode
```
public WebSocketSettings withPeriodicKeepAliveMode(java.lang.String newValue)
```
    Specified by:
    
    withPeriodicKeepAliveMode in interface WebSocketSettings
  - withRandomFactoryFactory
```
public WebSocketSettings withRandomFactoryFactory(java.util.function.Supplier<java.util.Random> newValue)
```
    Specified by:
    
    withRandomFactoryFactory in interface WebSocketSettings

Class WebSocketSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface akka.http.javadsl.settings.WebSocketSettings

Constructor Detail

WebSocketSettings

Method Detail

getPeriodicKeepAliveData

getRandomFactory

logFrames

periodicKeepAliveData

periodicKeepAliveMaxIdle

periodicKeepAliveMode

randomFactory

receiveIdleTimeout

sendIdleTimeout

withLogFrames

withPeriodicKeepAliveData

withPeriodicKeepAliveMaxIdle

withPeriodicKeepAliveMode

withRandomFactoryFactory