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. 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 getRequestedProtocols(): Iterable[String]

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade → UpgradeToWebSocket → WebSocketUpgrade
  17. 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
  18. 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
  19. 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
  20. def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _]): HttpResponse

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → WebSocketUpgrade → UpgradeToWebSocket → WebSocketUpgrade
  21. 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
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. 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
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeader → HttpHeader
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any
  31. def unsafeToString: String
    Definition Classes
    HttpHeader
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. 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 javadsl.model.ws.UpgradeToWebSocket

Inherited from javadsl.model.ws.WebSocketUpgrade

Inherited from HttpHeader

Inherited from ToStringRenderable

Inherited from Renderable

Inherited from javadsl.model.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