trait WebSocketUpgrade extends javadsl.model.ws.WebSocketUpgrade
An attribute that will be added to an WebSocket upgrade HttpRequest that enables a request handler to upgrade this connection to a WebSocket connection and registers a WebSocket handler.
This is a low-level API. You might want to use handleWebSocketMessages
instead as documented
at https://doc.akka.io/libraries/akka-http/current/server-side/websocket-support.html#routing-support
- Source
- WebSocketUpgrade.scala
- Alphabetic
- By Inheritance
- WebSocketUpgrade
- WebSocketUpgrade
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def handleMessages(handlerFlow: Graph[FlowShape[Message, Message], Any], subprotocol: Option[String] = None): HttpResponse
The high-level interface to create a WebSocket server based on "messages".
The high-level interface to create a WebSocket server based on "messages".
Returns a response to return in a request handler that will signal the low-level HTTP implementation to upgrade the connection to WebSocket and use the supplied handler to handle incoming WebSocket messages.
Optionally, a subprotocol out of the ones requested by the client can be chosen.
- abstract def requestedProtocols: Seq[String]
A sequence of protocols the client accepts.
A sequence of protocols the client accepts.
See http://tools.ietf.org/html/rfc6455#section-1.9
Concrete Value Members
- def getRequestedProtocols(): Iterable[String]
Java API
Java API
- Definition Classes
- WebSocketUpgrade → WebSocketUpgrade
- def handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _], subprotocol: String): HttpResponse
Java API
Java API
- Definition Classes
- WebSocketUpgrade → WebSocketUpgrade
- def handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _]): HttpResponse
Java API
Java API
- Definition Classes
- WebSocketUpgrade → WebSocketUpgrade
- def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _], subprotocol: String): HttpResponse
Java API
Java API
- Definition Classes
- WebSocketUpgrade → WebSocketUpgrade
- def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _]): HttpResponse
Java API
Java API
- Definition Classes
- WebSocketUpgrade → WebSocketUpgrade
- def handleMessagesWithSinkSource(inSink: Graph[SinkShape[Message], Any], outSource: Graph[SourceShape[Message], Any], subprotocol: Option[String] = None): HttpResponse
The high-level interface to create a WebSocket server based on "messages".
The high-level interface to create a WebSocket server based on "messages".
Returns a response to return in a request handler that will signal the low-level HTTP implementation to upgrade the connection to WebSocket and use the supplied inSink to consume messages received from the client and the supplied outSource to produce message to sent to the client.
Optionally, a subprotocol out of the ones requested by the client can be chosen.