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
- Alphabetic
- By Inheritance
- UpgradeToWebSocket
- UpgradeToWebSocket
- HttpHeader
- ToStringRenderable
- Renderable
- HttpHeader
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
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.
-
abstract
def
lowercaseName(): String
Returns the lower-cased name of the header.
Returns the lower-cased name of the header.
- Definition Classes
- HttpHeader → HttpHeader
-
abstract
def
name(): String
Returns the name of the header.
Returns the name of the header.
- Definition Classes
- HttpHeader → HttpHeader
-
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
-
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
-
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
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getRequestedProtocols(): Iterable[String]
Java API
Java API
- Definition Classes
- UpgradeToWebSocket → UpgradeToWebSocket
-
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 → UpgradeToWebSocket
-
def
handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _]): HttpResponse
Java API
Java API
- Definition Classes
- UpgradeToWebSocket → UpgradeToWebSocket
-
def
handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _], subprotocol: String): HttpResponse
Java API
Java API
- Definition Classes
- UpgradeToWebSocket → UpgradeToWebSocket
-
def
handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _]): HttpResponse
Java API
Java API
- Definition Classes
- UpgradeToWebSocket → UpgradeToWebSocket
-
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.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isNot(nameInLowerCase: String): Boolean
Returns !is(nameInLowerCase).
Returns !is(nameInLowerCase).
- Definition Classes
- HttpHeader → HttpHeader
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- ToStringRenderable → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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