Trait

akka.http.javadsl.model.ws

UpgradeToWebSocket

Related Doc: package ws

Permalink

trait UpgradeToWebSocket extends scaladsl.model.HttpHeader

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.

Source
UpgradeToWebSocket.scala
Linear Supertypes
scaladsl.model.HttpHeader, ToStringRenderable, Renderable, HttpHeader, AnyRef, Any
Known Subclasses
UpgradeToWebSocket
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UpgradeToWebSocket
  2. HttpHeader
  3. ToStringRenderable
  4. Renderable
  5. HttpHeader
  6. AnyRef
  7. 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 getRequestedProtocols(): Iterable[String]

    Permalink

    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

  2. abstract def handleMessagesWith(inSink: Graph[SinkShape[Message], _], outSource: Graph[SourceShape[Message], _], subprotocol: String): HttpResponse

    Permalink

    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.

  3. abstract def handleMessagesWith(inSink: Graph[SinkShape[Message], _], outSource: Graph[SourceShape[Message], _]): HttpResponse

    Permalink

    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.

  4. abstract def handleMessagesWith(handlerFlow: Graph[FlowShape[Message, Message], _], subprotocol: String): HttpResponse

    Permalink

    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.

  5. abstract def handleMessagesWith(handlerFlow: Graph[FlowShape[Message, Message], _]): HttpResponse

    Permalink

    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.

  6. abstract def lowercaseName(): String

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  7. abstract def name(): String

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  8. abstract def renderInRequests(): Boolean

    Permalink
    Definition Classes
    HttpHeader

  9. abstract def renderInResponses(): Boolean

    Permalink
    Definition Classes
    HttpHeader

  10. 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 hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. def is(nameInLowerCase: String): Boolean

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. def isNot(nameInLowerCase: String): Boolean

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

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

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  25. def toString(): String

    Permalink
    Definition Classes
    ToStringRenderable → AnyRef → Any

  26. final def wait(): Unit

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

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

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

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

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

  29. 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 scaladsl.model.HttpHeader

Inherited from ToStringRenderable

Inherited from Renderable

Inherited from 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