trait UpgradeToWebSocket extends scaladsl.model.HttpHeader with WebSocketUpgrade
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.
This low-level API is expected to be replaced by an Attribute in the future.
In any case, you might want to use handleWebSocketMessages instead as documented
at https://doc.akka.io/libraries/akka-http/current/server-side/websocket-support.html#routing-support
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version 10.2.0) use the WebSocketUpgrade attribute instead
- Source
- UpgradeToWebSocket.scala
- Alphabetic
- By Inheritance
- UpgradeToWebSocket
- WebSocketUpgrade
- HttpHeader
- ToStringRenderable
- Renderable
- HttpHeader
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def getRequestedProtocols(): Iterable[String]
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
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- abstract def handleMessagesWith(inSink: Graph[SinkShape[Message], _], outSource: Graph[SourceShape[Message], _], subprotocol: String): HttpResponse
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.
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- abstract def handleMessagesWith(inSink: Graph[SinkShape[Message], _], outSource: Graph[SourceShape[Message], _]): HttpResponse
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.
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- abstract def handleMessagesWith(handlerFlow: Graph[FlowShape[Message, Message], _], subprotocol: String): HttpResponse
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.
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- abstract def handleMessagesWith(handlerFlow: Graph[FlowShape[Message, Message], _]): HttpResponse
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.
- Definition Classes
- UpgradeToWebSocket → WebSocketUpgrade
- 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 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 toany2stringadd[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 toArrowAssoc[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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ToStringRenderable → AnyRef → Any
- def unsafeToString: String
- Definition Classes
- HttpHeader
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.