org.apache.pekko.http.scaladsl.model.ws

Interface WebSocketUpgrade

All Superinterfaces:

WebSocketUpgrade

All Known Subinterfaces:

UpgradeToWebSocket

public interface WebSocketUpgrade
extends 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://pekko.apache.org/docs/pekko-http/current/server-side/websocket-support.html#routing-support

Method Summary

Modifier and Type	Method and Description
org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<Message,Message>,org.apache.pekko.NotUsed>	createScalaFlow(org.apache.pekko.stream.Graph<org.apache.pekko.stream.SinkShape<Message>,?> inSink, org.apache.pekko.stream.Graph<org.apache.pekko.stream.SourceShape<Message>,?> outSource) Java API
java.lang.Iterable<java.lang.String>	getRequestedProtocols() Java API
HttpResponse	handleMessages(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<Message,Message>,java.lang.Object> handlerFlow, scala.Option<java.lang.String> subprotocol) The high-level interface to create a WebSocket server based on "messages".
HttpResponse	handleMessagesWith(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<Message,Message>,?> handlerFlow) Java API
HttpResponse	handleMessagesWith(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<Message,Message>,?> handlerFlow, java.lang.String subprotocol) Java API
HttpResponse	handleMessagesWith(org.apache.pekko.stream.Graph<org.apache.pekko.stream.SinkShape<Message>,?> inSink, org.apache.pekko.stream.Graph<org.apache.pekko.stream.SourceShape<Message>,?> outSource) Java API
HttpResponse	handleMessagesWith(org.apache.pekko.stream.Graph<org.apache.pekko.stream.SinkShape<Message>,?> inSink, org.apache.pekko.stream.Graph<org.apache.pekko.stream.SourceShape<Message>,?> outSource, java.lang.String subprotocol) Java API
HttpResponse	handleMessagesWithSinkSource(org.apache.pekko.stream.Graph<org.apache.pekko.stream.SinkShape<Message>,java.lang.Object> inSink, org.apache.pekko.stream.Graph<org.apache.pekko.stream.SourceShape<Message>,java.lang.Object> outSource, scala.Option<java.lang.String> subprotocol) The high-level interface to create a WebSocket server based on "messages".
scala.collection.immutable.Seq<java.lang.String>	requestedProtocols() A sequence of protocols the client accepts.

Method Detail

createScalaFlow

org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<Message,Message>,org.apache.pekko.NotUsed> createScalaFlow(org.apache.pekko.stream.Graph<org.apache.pekko.stream.SinkShape<Message>,?> inSink,
                                                                                                                           org.apache.pekko.stream.Graph<org.apache.pekko.stream.SourceShape<Message>,?> outSource)

Java API

Parameters:

inSink - (undocumented)

outSource - (undocumented)

Returns:

(undocumented)

getRequestedProtocols

java.lang.Iterable<java.lang.String> getRequestedProtocols()

Java API

Specified by:

getRequestedProtocols in interface WebSocketUpgrade

Returns:

(undocumented)

handleMessages

HttpResponse handleMessages(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<Message,Message>,java.lang.Object> handlerFlow,
                            scala.Option<java.lang.String> subprotocol)

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.

Parameters:

handlerFlow - (undocumented)

subprotocol - (undocumented)

Returns:

(undocumented)

handleMessagesWith

HttpResponse handleMessagesWith(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<Message,Message>,?> handlerFlow)

Java API

Specified by:

handleMessagesWith in interface WebSocketUpgrade

Parameters:

handlerFlow - (undocumented)

Returns:

(undocumented)

handleMessagesWith

HttpResponse handleMessagesWith(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<Message,Message>,?> handlerFlow,
                                java.lang.String subprotocol)

Java API

Specified by:

handleMessagesWith in interface WebSocketUpgrade

Parameters:

handlerFlow - (undocumented)

subprotocol - (undocumented)

Returns:

(undocumented)

handleMessagesWith

HttpResponse handleMessagesWith(org.apache.pekko.stream.Graph<org.apache.pekko.stream.SinkShape<Message>,?> inSink,
                                org.apache.pekko.stream.Graph<org.apache.pekko.stream.SourceShape<Message>,?> outSource)

Java API

Specified by:

handleMessagesWith in interface WebSocketUpgrade

Parameters:

inSink - (undocumented)

outSource - (undocumented)

Returns:

(undocumented)

handleMessagesWith

HttpResponse handleMessagesWith(org.apache.pekko.stream.Graph<org.apache.pekko.stream.SinkShape<Message>,?> inSink,
                                org.apache.pekko.stream.Graph<org.apache.pekko.stream.SourceShape<Message>,?> outSource,
                                java.lang.String subprotocol)

Java API

Specified by:

handleMessagesWith in interface WebSocketUpgrade

Parameters:

inSink - (undocumented)

outSource - (undocumented)

subprotocol - (undocumented)

Returns:

(undocumented)

handleMessagesWithSinkSource

HttpResponse handleMessagesWithSinkSource(org.apache.pekko.stream.Graph<org.apache.pekko.stream.SinkShape<Message>,java.lang.Object> inSink,
                                          org.apache.pekko.stream.Graph<org.apache.pekko.stream.SourceShape<Message>,java.lang.Object> outSource,
                                          scala.Option<java.lang.String> subprotocol)

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.

Parameters:

inSink - (undocumented)

outSource - (undocumented)

subprotocol - (undocumented)

Returns:

(undocumented)

requestedProtocols

scala.collection.immutable.Seq<java.lang.String> requestedProtocols()

A sequence of protocols the client accepts.

See http://tools.ietf.org/html/rfc6455#section-1.9

Returns:

(undocumented)