root
API
Generated with
root/org.apache.pekko.http.play/WebSocketHandler

WebSocketHandler

org.apache.pekko.http.play.WebSocketHandler
object WebSocketHandler

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

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

Handle a WebSocket

Handle a WebSocket

Attributes

def messageFlowToFrameFlow(flow: Flow[Message, 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.

Attributes

Deprecated methods

def handleWebSocket(upgrade: UpgradeToWebSocket, flow: Flow[Message, 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

Attributes

Deprecated
true
def handleWebSocket(upgrade: UpgradeToWebSocket, flow: Flow[Message, Message, _], bufferLimit: Int, subprotocol: Option[String]): HttpResponse

Attributes

Deprecated
true
def messageFlowToFrameFlow(flow: Flow[Message, 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.

Attributes

Deprecated
true
Generated with