o

org.apache.pekko.http.play

WebSocketHandler

object WebSocketHandler

Source
WebSocketHandler.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketHandler
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def handleWebSocket(upgrade: UpgradeToWebSocket, flow: Flow[, Message, _], bufferLimit: Int, subprotocol: Option[String], wsKeepAliveMode: String, wsKeepAliveMaxIdle: Duration): HttpResponse

    Handle a WebSocket

  2. def messageFlowToFrameFlow(flow: Flow[, Message, _], bufferLimit: Int, wsKeepAliveMode: String, wsKeepAliveMaxIdle: Duration): Flow[FrameEvent, FrameEvent, _]

    Convert a flow of messages to a flow of frame events.

    Convert a flow of messages to a flow of frame events.

    This implements the WebSocket control logic, including handling ping frames and closing the connection in a spec compliant manner.

Deprecated Value Members

  1. def handleWebSocket(upgrade: UpgradeToWebSocket, flow: Flow[, Message, _], bufferLimit: Int, subprotocol: Option[String]): HttpResponse
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.19) Please specify the keep-alive mode (ping or pong) and max-idle time

  2. def handleWebSocket(upgrade: UpgradeToWebSocket, flow: Flow[, Message, _], bufferLimit: Int): HttpResponse

    Handle a WebSocket without selecting a subprotocol

    Handle a WebSocket without selecting a subprotocol

    This may cause problems with clients that propose subprotocols in the upgrade request and expect the server to pick one, such as Chrome.

    See https://github.com/playframework/playframework/issues/7895

    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Please specify the subprotocol (or be explicit that you specif None)

  3. def messageFlowToFrameFlow(flow: Flow[, Message, _], bufferLimit: Int): Flow[FrameEvent, FrameEvent, _]

    Convert a flow of messages to a flow of frame events.

    Convert a flow of messages to a flow of frame events.

    This implements the WebSocket control logic, including handling ping frames and closing the connection in a spec compliant manner.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.19) Please specify the keep-alive mode (ping or pong) and max-idle time