Package org.apache.pekko.http.javadsl.settings

Interface WebSocketSettings

All Known Implementing Classes:
WebSocketSettings, WebSocketSettingsImpl
public interface WebSocketSettings
Public API but not intended for subclassing

  • Method Details

    • getRandomFactory

      Supplier<Random> getRandomFactory()

    • periodicKeepAliveMode

      String periodicKeepAliveMode()

    • periodicKeepAliveMaxIdle

      scala.concurrent.duration.Duration periodicKeepAliveMaxIdle()

    • getPeriodicKeepAliveMaxIdle

      Duration getPeriodicKeepAliveMaxIdle()
      Java API
      Returns:
      (undocumented)
      Since:
      1.3.0

    • getPeriodicKeepAliveData

      Supplier<org.apache.pekko.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)

    • receiveIdleTimeout

      scala.concurrent.duration.Duration receiveIdleTimeout()
      Maximum allowable time between two consecutive frames being received. If exceeded, the WebSocket flow is failed with a pekko.http.scaladsl.model.ws.WebSocketIdleTimeoutException. Duration.Inf disables the check.

      Returns:
      (undocumented)
      Since:
      2.0.0

    • getReceiveIdleTimeout

      Duration getReceiveIdleTimeout()
      Java API
      Returns:
      (undocumented)
      Since:
      2.0.0

    • sendIdleTimeout

      scala.concurrent.duration.Duration sendIdleTimeout()
      Maximum allowable time between two consecutive frames being sent. If exceeded, the WebSocket flow is failed with a pekko.http.scaladsl.model.ws.WebSocketIdleTimeoutException. Duration.Inf disables the check.

      Returns:
      (undocumented)
      Since:
      2.0.0

    • getSendIdleTimeout

      Duration getSendIdleTimeout()
      Java API
      Returns:
      (undocumented)
      Since:
      2.0.0

    • withRandomFactoryFactory

      WebSocketSettings withRandomFactoryFactory(Supplier<Random> newValue)

    • withPeriodicKeepAliveMode

      WebSocketSettings withPeriodicKeepAliveMode(String newValue)

    • withPeriodicKeepAliveMaxIdle

      WebSocketSettings withPeriodicKeepAliveMaxIdle(scala.concurrent.duration.Duration newValue)

    • withPeriodicKeepAliveMaxIdle

      WebSocketSettings withPeriodicKeepAliveMaxIdle(Duration newValue)
      Parameters:
      newValue - (undocumented)
      Returns:
      (undocumented)
      Since:
      1.3.0

    • withPeriodicKeepAliveData

      WebSocketSettings withPeriodicKeepAliveData(Supplier<org.apache.pekko.util.ByteString> newValue)

    • withReceiveIdleTimeout

      WebSocketSettings withReceiveIdleTimeout(scala.concurrent.duration.Duration newValue)
      Parameters:
      newValue - (undocumented)
      Returns:
      (undocumented)
      Since:
      2.0.0

    • withReceiveIdleTimeout

      WebSocketSettings withReceiveIdleTimeout(Duration newValue)
      Parameters:
      newValue - (undocumented)
      Returns:
      (undocumented)
      Since:
      2.0.0

    • withSendIdleTimeout

      WebSocketSettings withSendIdleTimeout(scala.concurrent.duration.Duration newValue)
      Parameters:
      newValue - (undocumented)
      Returns:
      (undocumented)
      Since:
      2.0.0

    • withSendIdleTimeout

      WebSocketSettings withSendIdleTimeout(Duration newValue)
      Parameters:
      newValue - (undocumented)
      Returns:
      (undocumented)
      Since:
      2.0.0

    • logFrames

      boolean logFrames()

    • withLogFrames

      WebSocketSettings withLogFrames(boolean shouldLog)