Packages

t

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

UpgradeToWebSocket

trait UpgradeToWebSocket extends HttpHeader with javadsl.model.ws.UpgradeToWebSocket with WebSocketUpgrade

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.

Annotations
@deprecated
Deprecated

(Since version Akka HTTP 10.2.0) This low-level API has been replaced by an attribute.

Source
UpgradeToWebSocket.scala
Linear Supertypes
WebSocketUpgrade, javadsl.model.ws.UpgradeToWebSocket, javadsl.model.ws.WebSocketUpgrade, HttpHeader, ToStringRenderable, Renderable, javadsl.model.HttpHeader, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UpgradeToWebSocket
  2. WebSocketUpgrade
  3. UpgradeToWebSocket
  4. WebSocketUpgrade
  5. HttpHeader
  6. ToStringRenderable
  7. Renderable
  8. HttpHeader
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. 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.

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade
  2. abstract def lowercaseName(): String

    Returns the lower-cased name of the header.

    Returns the lower-cased name of the header.

    Definition Classes
    HttpHeader → HttpHeader
  3. abstract def name(): String

    Returns the name of the header.

    Returns the name of the header.

    Definition Classes
    HttpHeader → HttpHeader
  4. 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
  5. 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
  6. 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

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade
  7. 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

  1. def getRequestedProtocols(): Iterable[String]

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade → UpgradeToWebSocket → WebSocketUpgrade
  2. 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 → WebSocketUpgrade → UpgradeToWebSocket → WebSocketUpgrade
  3. def handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _]): HttpResponse

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade → UpgradeToWebSocket → WebSocketUpgrade
  4. def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _], subprotocol: String): HttpResponse

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade → UpgradeToWebSocket → WebSocketUpgrade
  5. def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _]): HttpResponse

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade → UpgradeToWebSocket → WebSocketUpgrade
  6. 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.

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade
  7. 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
  8. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeader → HttpHeader
  9. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any
  10. def unsafeToString: String
    Definition Classes
    HttpHeader