Trait

akka.http.scaladsl.model.ws

UpgradeToWebSocket

Related Doc: package ws

Permalink

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
javadsl.model.ws.UpgradeToWebSocket, HttpHeader, ToStringRenderable, Renderable, javadsl.model.HttpHeader, AnyRef, Any
Type Hierarchy
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

    Permalink

    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

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  3. abstract def name(): String

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  4. abstract def renderInRequests(): Boolean

    Permalink
    Definition Classes
    HttpHeader

  5. abstract def renderInResponses(): Boolean

    Permalink
    Definition Classes
    HttpHeader

  6. abstract def requestedProtocols: Seq[String]

    Permalink

    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

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    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)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (UpgradeToWebSocket) ⇒ Boolean, msg: ⇒ Any): UpgradeToWebSocket

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def getRequestedProtocols(): Iterable[String]

    Permalink

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → UpgradeToWebSocket

  18. def handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _], subprotocol: String): HttpResponse

    Permalink

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → UpgradeToWebSocket

  19. def handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _]): HttpResponse

    Permalink

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → UpgradeToWebSocket

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

    Permalink

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → UpgradeToWebSocket

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

    Permalink

    Java API

    Java API

    Definition Classes
    UpgradeToWebSocket → UpgradeToWebSocket

  22. def handleMessagesWithSinkSource(inSink: Graph[SinkShape[Message], Any], outSource: Graph[SourceShape[Message], Any], subprotocol: Option[String] = None): HttpResponse

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any

  24. def is(nameInLowerCase: String): Boolean

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  26. def isNot(nameInLowerCase: String): Boolean

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  31. def toString(): String

    Permalink
    Definition Classes
    ToStringRenderable → AnyRef → Any

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. def →[B](y: B): (UpgradeToWebSocket, B)

    Permalink
    Implicit information
    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 javadsl.model.ws.UpgradeToWebSocket

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