Packages

t

org.apache.pekko.http.javadsl.model.ws

UpgradeToWebSocket

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
Linear Supertypes
WebSocketUpgrade, scaladsl.model.HttpHeader, ToStringRenderable, Renderable, HttpHeader, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UpgradeToWebSocket
  2. WebSocketUpgrade
  3. HttpHeader
  4. ToStringRenderable
  5. Renderable
  6. HttpHeader
  7. AnyRef
  8. 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 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
    UpgradeToWebSocketWebSocketUpgrade
  2. 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
    UpgradeToWebSocketWebSocketUpgrade
  3. 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
    UpgradeToWebSocketWebSocketUpgrade
  4. 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
    UpgradeToWebSocketWebSocketUpgrade
  5. 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
    UpgradeToWebSocketWebSocketUpgrade
  6. abstract def lowercaseName(): String

    Returns the lower-cased name of the header.

    Returns the lower-cased name of the header.

    Definition Classes
    HttpHeaderHttpHeader
  7. abstract def name(): String

    Returns the name of the header.

    Returns the name of the header.

    Definition Classes
    HttpHeaderHttpHeader
  8. 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
  9. 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
  10. 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
    HttpHeaderHttpHeader

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket toany2stringadd[UpgradeToWebSocket] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (UpgradeToWebSocket, B)
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket toArrowAssoc[UpgradeToWebSocket] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (UpgradeToWebSocket) => Boolean, msg: => Any): UpgradeToWebSocket
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket toEnsuring[UpgradeToWebSocket] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (UpgradeToWebSocket) => Boolean): UpgradeToWebSocket
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket toEnsuring[UpgradeToWebSocket] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): UpgradeToWebSocket
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket toEnsuring[UpgradeToWebSocket] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): UpgradeToWebSocket
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket toEnsuring[UpgradeToWebSocket] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. 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
    HttpHeaderHttpHeader
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeaderHttpHeader
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any
  25. def unsafeToString: String
    Definition Classes
    HttpHeader
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket toStringFormat[UpgradeToWebSocket] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (UpgradeToWebSocket, B)
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket toArrowAssoc[UpgradeToWebSocket] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from WebSocketUpgrade

Inherited from ToStringRenderable

Inherited from Renderable

Inherited from HttpHeader

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromUpgradeToWebSocket to any2stringadd[UpgradeToWebSocket]

Inherited by implicit conversion StringFormat fromUpgradeToWebSocket to StringFormat[UpgradeToWebSocket]

Inherited by implicit conversion Ensuring fromUpgradeToWebSocket to Ensuring[UpgradeToWebSocket]

Inherited by implicit conversion ArrowAssoc fromUpgradeToWebSocket to ArrowAssoc[UpgradeToWebSocket]

Ungrouped