trait UpgradeToWebSocket extends HttpHeader with javadsl.model.ws.UpgradeToWebSocket
A custom header 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.
- Source
- UpgradeToWebSocket.scala
- Alphabetic
- By Inheritance
- UpgradeToWebSocket
- UpgradeToWebSocket
- HttpHeader
- ToStringRenderable
- Renderable
- HttpHeader
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
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
lowercaseName(): String
Returns the lower-cased name of the header.
Returns the lower-cased name of the header.
- Definition Classes
- HttpHeader → HttpHeader
-
abstract
def
name(): String
Returns the name of the header.
Returns the name of the header.
- Definition Classes
- HttpHeader → HttpHeader
-
abstract
def
renderInRequests(): Boolean
Returns true if and only if the header is to be rendered in requests.
Returns true if and only if the header is to be rendered in requests.
- Definition Classes
- HttpHeader
-
abstract
def
renderInResponses(): Boolean
Returns true if and only if the header is to be rendered in responses.
Returns true if and only if the header is to be rendered in responses.
- Definition Classes
- HttpHeader
-
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
-
abstract
def
value(): String
Returns the String representation of the value of the header.
Returns the String representation of the value of the header.
- Definition Classes
- HttpHeader → HttpHeader
Concrete Value Members
-
def
getRequestedProtocols(): Iterable[String]
Java API
Java API
- Definition Classes
- UpgradeToWebSocket → UpgradeToWebSocket
-
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
- UpgradeToWebSocket → UpgradeToWebSocket
-
def
handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _]): HttpResponse
Java API
Java API
- Definition Classes
- UpgradeToWebSocket → UpgradeToWebSocket
-
def
handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _], subprotocol: String): HttpResponse
Java API
Java API
- Definition Classes
- UpgradeToWebSocket → UpgradeToWebSocket
-
def
handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _]): HttpResponse
Java API
Java API
- Definition Classes
- UpgradeToWebSocket → UpgradeToWebSocket
-
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.
-
def
is(nameInLowerCase: String): Boolean
Returns true if and only if nameInLowerCase.equals(lowercaseName()).
Returns true if and only if nameInLowerCase.equals(lowercaseName()).
- Definition Classes
- HttpHeader → HttpHeader
-
def
isNot(nameInLowerCase: String): Boolean
Returns !is(nameInLowerCase).
Returns !is(nameInLowerCase).
- Definition Classes
- HttpHeader → HttpHeader
-
def
toString(): String
- Definition Classes
- ToStringRenderable → AnyRef → Any