Package akka.http.scaladsl.model.ws

Interface UpgradeToWebSocket

    • Method Detail

      • createScalaFlow

        akka.stream.Graph<akka.stream.FlowShape<Message,​Message>,​akka.NotUsed> createScalaFlow​(akka.stream.Graph<akka.stream.SinkShape<Message>,​?> inSink,
                                                                                                   akka.stream.Graph<akka.stream.SourceShape<Message>,​?> outSource)
        Deprecated.
        Java API
        Specified by:
        createScalaFlow in interface WebSocketUpgrade
        Parameters:
        inSink - (undocumented)
        outSource - (undocumented)
        Returns:
        (undocumented)

      • handleMessages

        HttpResponse handleMessages​(akka.stream.Graph<akka.stream.FlowShape<Message,​Message>,​java.lang.Object> handlerFlow,
                            scala.Option<java.lang.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 interface WebSocketUpgrade
        Parameters:
        handlerFlow - (undocumented)
        subprotocol - (undocumented)
        Returns:
        (undocumented)

      • handleMessagesWithSinkSource

        HttpResponse handleMessagesWithSinkSource​(akka.stream.Graph<akka.stream.SinkShape<Message>,​java.lang.Object> inSink,
                                          akka.stream.Graph<akka.stream.SourceShape<Message>,​java.lang.Object> outSource,
                                          scala.Option<java.lang.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 interface WebSocketUpgrade
        Parameters:
        inSink - (undocumented)
        outSource - (undocumented)
        subprotocol - (undocumented)
        Returns:
        (undocumented)

      • requestedProtocols

        scala.collection.immutable.Seq<java.lang.String> requestedProtocols()
        Deprecated.
        A sequence of protocols the client accepts.

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

        Specified by:
        requestedProtocols in interface WebSocketUpgrade
        Returns:
        (undocumented)