Package akka.http.scaladsl.model.ws
Interface UpgradeToWebSocket
- All Superinterfaces:
UpgradeToWebSocket
,WebSocketUpgrade
,WebSocketUpgrade
- All Known Implementing Classes:
UpgradeToWebSocketLowLevel
Deprecated.
This low-level API has been replaced by an attribute. Since 10.2.0.
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.
-
Method Summary
Modifier and TypeMethodDescriptioncreateScalaFlow
(akka.stream.Graph<akka.stream.SinkShape<Message>, ?> inSink, akka.stream.Graph<akka.stream.SourceShape<Message>, ?> outSource) Deprecated.Java APIDeprecated.Java APIhandleMessages
(akka.stream.Graph<akka.stream.FlowShape<Message, Message>, Object> handlerFlow, scala.Option<String> subprotocol) Deprecated.The high-level interface to create a WebSocket server based on "messages".handleMessagesWith
(akka.stream.Graph<akka.stream.FlowShape<Message, Message>, ?> handlerFlow) Deprecated.Java APIhandleMessagesWith
(akka.stream.Graph<akka.stream.FlowShape<Message, Message>, ?> handlerFlow, String subprotocol) Deprecated.Java APIhandleMessagesWith
(akka.stream.Graph<akka.stream.SinkShape<Message>, ?> inSink, akka.stream.Graph<akka.stream.SourceShape<Message>, ?> outSource) Deprecated.Java APIhandleMessagesWith
(akka.stream.Graph<akka.stream.SinkShape<Message>, ?> inSink, akka.stream.Graph<akka.stream.SourceShape<Message>, ?> outSource, String subprotocol) Deprecated.Java APIhandleMessagesWithSinkSource
(akka.stream.Graph<akka.stream.SinkShape<Message>, Object> inSink, akka.stream.Graph<akka.stream.SourceShape<Message>, Object> outSource, scala.Option<String> subprotocol) Deprecated.The high-level interface to create a WebSocket server based on "messages".scala.collection.immutable.Seq<String>
Deprecated.A sequence of protocols the client accepts.
-
Method Details
-
createScalaFlow
akka.stream.Graph<akka.stream.FlowShape<Message,Message>, createScalaFlowakka.NotUsed> (akka.stream.Graph<akka.stream.SinkShape<Message>, ?> inSink, akka.stream.Graph<akka.stream.SourceShape<Message>, ?> outSource) Deprecated.Java API- Specified by:
createScalaFlow
in interfaceWebSocketUpgrade
- Parameters:
inSink
- (undocumented)outSource
- (undocumented)- Returns:
- (undocumented)
-
getRequestedProtocols
Deprecated.Java API- Specified by:
getRequestedProtocols
in interfaceUpgradeToWebSocket
- Specified by:
getRequestedProtocols
in interfaceWebSocketUpgrade
- Specified by:
getRequestedProtocols
in interfaceWebSocketUpgrade
- Returns:
- (undocumented)
-
handleMessages
HttpResponse handleMessages(akka.stream.Graph<akka.stream.FlowShape<Message, Message>, Object> handlerFlow, scala.Option<String> subprotocol) Deprecated.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.
- Specified by:
handleMessages
in interfaceWebSocketUpgrade
- Parameters:
handlerFlow
- (undocumented)subprotocol
- (undocumented)- Returns:
- (undocumented)
-
handleMessagesWith
HttpResponse handleMessagesWith(akka.stream.Graph<akka.stream.FlowShape<Message, Message>, ?> handlerFlow) Deprecated.Java API- Specified by:
handleMessagesWith
in interfaceUpgradeToWebSocket
- Specified by:
handleMessagesWith
in interfaceWebSocketUpgrade
- Specified by:
handleMessagesWith
in interfaceWebSocketUpgrade
- Parameters:
handlerFlow
- (undocumented)- Returns:
- (undocumented)
-
handleMessagesWith
HttpResponse handleMessagesWith(akka.stream.Graph<akka.stream.FlowShape<Message, Message>, ?> handlerFlow, String subprotocol) Deprecated.Java API- Specified by:
handleMessagesWith
in interfaceUpgradeToWebSocket
- Specified by:
handleMessagesWith
in interfaceWebSocketUpgrade
- Specified by:
handleMessagesWith
in interfaceWebSocketUpgrade
- Parameters:
handlerFlow
- (undocumented)subprotocol
- (undocumented)- Returns:
- (undocumented)
-
handleMessagesWith
HttpResponse handleMessagesWith(akka.stream.Graph<akka.stream.SinkShape<Message>, ?> inSink, akka.stream.Graph<akka.stream.SourceShape<Message>, ?> outSource) Deprecated.Java API- Specified by:
handleMessagesWith
in interfaceUpgradeToWebSocket
- Specified by:
handleMessagesWith
in interfaceWebSocketUpgrade
- Specified by:
handleMessagesWith
in interfaceWebSocketUpgrade
- Parameters:
inSink
- (undocumented)outSource
- (undocumented)- Returns:
- (undocumented)
-
handleMessagesWith
HttpResponse handleMessagesWith(akka.stream.Graph<akka.stream.SinkShape<Message>, ?> inSink, akka.stream.Graph<akka.stream.SourceShape<Message>, ?> outSource, String subprotocol) Deprecated.Java API- Specified by:
handleMessagesWith
in interfaceUpgradeToWebSocket
- Specified by:
handleMessagesWith
in interfaceWebSocketUpgrade
- Specified by:
handleMessagesWith
in interfaceWebSocketUpgrade
- Parameters:
inSink
- (undocumented)outSource
- (undocumented)subprotocol
- (undocumented)- Returns:
- (undocumented)
-
handleMessagesWithSinkSource
HttpResponse handleMessagesWithSinkSource(akka.stream.Graph<akka.stream.SinkShape<Message>, Object> inSink, akka.stream.Graph<akka.stream.SourceShape<Message>, Object> outSource, scala.Option<String> subprotocol) Deprecated.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.
- Specified by:
handleMessagesWithSinkSource
in interfaceWebSocketUpgrade
- Parameters:
inSink
- (undocumented)outSource
- (undocumented)subprotocol
- (undocumented)- Returns:
- (undocumented)
-
requestedProtocols
scala.collection.immutable.Seq<String> requestedProtocols()Deprecated.A sequence of protocols the client accepts.See http://tools.ietf.org/html/rfc6455#section-1.9
- Specified by:
requestedProtocols
in interfaceWebSocketUpgrade
- Returns:
- (undocumented)
-