Packages

t

akka.http.scaladsl.model.ws

UpgradeToWebSocket

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

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.

Source
UpgradeToWebSocket.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UpgradeToWebSocket
  2. UpgradeToWebSocket
  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. All

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.

  2. abstract def lowercaseName(): String

    Returns the lower-cased name of the header.

    Returns the lower-cased name of the header.

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

    Returns the name of the header.

    Returns the name of the header.

    Definition Classes
    HttpHeaderHttpHeader
  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

  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
    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 to any2stringadd[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 to ArrowAssoc[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( ... ) @native()
  8. def ensuring(cond: (UpgradeToWebSocket) ⇒ Boolean, msg: ⇒ Any): UpgradeToWebSocket
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket to Ensuring[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 to Ensuring[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 to Ensuring[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 to Ensuring[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: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket to StringFormat[UpgradeToWebSocket] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getRequestedProtocols(): Iterable[String]

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocketUpgradeToWebSocket
  18. 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
    UpgradeToWebSocketUpgradeToWebSocket
  19. def handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _]): HttpResponse

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocketUpgradeToWebSocket
  20. def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _], subprotocol: String): HttpResponse

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocketUpgradeToWebSocket
  21. def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _]): HttpResponse

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocketUpgradeToWebSocket
  22. 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.

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

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeaderHttpHeader
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. def [B](y: B): (UpgradeToWebSocket, B)
    Implicit
    This member is added by an implicit conversion from UpgradeToWebSocket to ArrowAssoc[UpgradeToWebSocket] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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 from UpgradeToWebSocket to any2stringadd[UpgradeToWebSocket]

Inherited by implicit conversion StringFormat from UpgradeToWebSocket to StringFormat[UpgradeToWebSocket]

Inherited by implicit conversion Ensuring from UpgradeToWebSocket to Ensuring[UpgradeToWebSocket]

Inherited by implicit conversion ArrowAssoc from UpgradeToWebSocket to ArrowAssoc[UpgradeToWebSocket]

Ungrouped