trait UpgradeToWebSocket extends scaladsl.model.HttpHeader with WebSocketUpgrade
A virtual header that WebSocket requests will contain. Use UpgradeToWebSocket.handleMessagesWith to create a WebSocket handshake response and handle the WebSocket message stream with the given handler.
This low-level API is expected to be replaced by an Attribute in the future.
In any case, you might want to use handleWebSocketMessages instead as documented
at https://pekko.apache.org/docs/pekko-http/current/server-side/websocket-support.html#routing-support
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version Akka HTTP 10.2.0) use the WebSocketUpgrade attribute instead
- Source
- UpgradeToWebSocket.scala
- Alphabetic
- By Inheritance
- UpgradeToWebSocket
- WebSocketUpgrade
- HttpHeader
- ToStringRenderable
- Renderable
- HttpHeader
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def getRequestedProtocols(): Iterable[String]
Returns the sequence of protocols the client accepts.
Returns the sequence of protocols the client accepts.
See http://tools.ietf.org/html/rfc6455#section-1.9
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- abstract def handleMessagesWith(inSink: Graph[SinkShape[Message], _], outSource: Graph[SourceShape[Message], _], subprotocol: String): HttpResponse
Returns a response that can be used to answer a WebSocket handshake request.
Returns a response that can be used to answer a WebSocket handshake request. The connection will afterwards use the given inSink to handle WebSocket messages from the client and the given outSource to send messages to the client.
The given subprotocol must be one of the ones offered by the client.
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- abstract def handleMessagesWith(inSink: Graph[SinkShape[Message], _], outSource: Graph[SourceShape[Message], _]): HttpResponse
Returns a response that can be used to answer a WebSocket handshake request.
Returns a response that can be used to answer a WebSocket handshake request. The connection will afterwards use the given inSink to handle WebSocket messages from the client and the given outSource to send messages to the client.
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- abstract def handleMessagesWith(handlerFlow: Graph[FlowShape[Message, Message], _], subprotocol: String): HttpResponse
Returns a response that can be used to answer a WebSocket handshake request.
Returns a response that can be used to answer a WebSocket handshake request. The connection will afterwards use the given handlerFlow to handle WebSocket messages from the client. The given subprotocol must be one of the ones offered by the client.
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- abstract def handleMessagesWith(handlerFlow: Graph[FlowShape[Message, Message], _]): HttpResponse
Returns a response that can be used to answer a WebSocket handshake request.
Returns a response that can be used to answer a WebSocket handshake request. The connection will afterwards use the given handlerFlow to handle WebSocket messages from the client.
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- 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 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 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
- def unsafeToString: String
- Definition Classes
- HttpHeader