c

akka.http.scaladsl.settings

WebSocketSettings

abstract class WebSocketSettings extends javadsl.settings.WebSocketSettings

Self Type
WebSocketSettingsImpl
Annotations
@DoNotInherit()
Source
WebSocketSettings.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketSettings
  2. WebSocketSettings
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WebSocketSettings()

Abstract Value Members

  1. abstract def logFrames: Boolean
    Definition Classes
    WebSocketSettingsWebSocketSettings
  2. abstract def periodicKeepAliveData: () => ByteString

    The provided function will be invoked for each new keep-alive frame that is sent.

    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.

  3. abstract def periodicKeepAliveMaxIdle: Duration
    Definition Classes
    WebSocketSettingsWebSocketSettings
  4. abstract def periodicKeepAliveMode: String
    Definition Classes
    WebSocketSettingsWebSocketSettings
  5. abstract def randomFactory: () => Random

Concrete Value Members

  1. final def getPeriodicKeepAliveData: Supplier[ByteString]

    The provided supplier will be invoked for each new keep-alive frame that is sent.

    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.

    Definition Classes
    WebSocketSettingsWebSocketSettings
  2. final val getRandomFactory: Supplier[Random]
    Definition Classes
    WebSocketSettingsWebSocketSettings
  3. def withLogFrames(shouldLog: Boolean): WebSocketSettings
    Definition Classes
    WebSocketSettingsWebSocketSettings
  4. def withPeriodicKeepAliveData(newValue: () => ByteString): WebSocketSettings
  5. def withPeriodicKeepAliveData(newValue: Supplier[ByteString]): javadsl.settings.WebSocketSettings
    Definition Classes
    WebSocketSettings
  6. def withPeriodicKeepAliveMaxIdle(newValue: Duration): WebSocketSettings
    Definition Classes
    WebSocketSettingsWebSocketSettings
  7. def withPeriodicKeepAliveMode(newValue: String): WebSocketSettings
    Definition Classes
    WebSocketSettingsWebSocketSettings
  8. def withRandomFactoryFactory(newValue: Supplier[Random]): WebSocketSettings
    Definition Classes
    WebSocketSettingsWebSocketSettings