t
org.apache.pekko.http.javadsl.model.ws
WebSocketUpgradeResponse
Companion object WebSocketUpgradeResponse
trait WebSocketUpgradeResponse extends AnyRef
Represents an upgrade response for a WebSocket upgrade request. Can either be valid, in which
case the chosenSubprotocol method is valid, or if invalid, the invalidationReason method
can be used to find out why the upgrade failed.
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- WebSocketUpgradeResponse
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Abstract Value Members
- abstract def chosenSubprotocol: Optional[String]
If valid, returns
Some(subprotocol)(if any was requested), orNoneif none was chosen or offered. - abstract def invalidationReason: String
If invalid, the reason why the server's upgrade response could not be accepted.
- abstract def isValid: Boolean
- abstract def response: HttpResponse
Returns the response object as received from the server for further inspection.
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 WebSocketUpgradeResponse toany2stringadd[WebSocketUpgradeResponse] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (WebSocketUpgradeResponse, B)
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toArrowAssoc[WebSocketUpgradeResponse] 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]) @native()
- def ensuring(cond: (WebSocketUpgradeResponse) => Boolean, msg: => Any): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (WebSocketUpgradeResponse) => Boolean): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toStringFormat[WebSocketUpgradeResponse] 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): (WebSocketUpgradeResponse, B)
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toArrowAssoc[WebSocketUpgradeResponse] 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.
Inherited from AnyRef
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
Inherited from Any
Inherited by implicit conversion any2stringadd fromWebSocketUpgradeResponse to any2stringadd[WebSocketUpgradeResponse]
Value Members
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toany2stringadd[WebSocketUpgradeResponse] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
Inherited by implicit conversion StringFormat fromWebSocketUpgradeResponse to StringFormat[WebSocketUpgradeResponse]
Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toStringFormat[WebSocketUpgradeResponse] 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.
Inherited by implicit conversion Ensuring fromWebSocketUpgradeResponse to Ensuring[WebSocketUpgradeResponse]
Value Members
- def ensuring(cond: (WebSocketUpgradeResponse) => Boolean, msg: => Any): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (WebSocketUpgradeResponse) => Boolean): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
Inherited by implicit conversion ArrowAssoc fromWebSocketUpgradeResponse to ArrowAssoc[WebSocketUpgradeResponse]
Value Members
- def ->[B](y: B): (WebSocketUpgradeResponse, B)
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toArrowAssoc[WebSocketUpgradeResponse] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- def →[B](y: B): (WebSocketUpgradeResponse, B)
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toArrowAssoc[WebSocketUpgradeResponse] 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.
Ungrouped
- abstract def chosenSubprotocol: Optional[String]
If valid, returns
Some(subprotocol)(if any was requested), orNoneif none was chosen or offered. - abstract def invalidationReason: String
If invalid, the reason why the server's upgrade response could not be accepted.
- abstract def isValid: Boolean
- abstract def response: HttpResponse
Returns the response object as received from the server for further inspection.
- 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 WebSocketUpgradeResponse toany2stringadd[WebSocketUpgradeResponse] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (WebSocketUpgradeResponse, B)
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toArrowAssoc[WebSocketUpgradeResponse] 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]) @native()
- def ensuring(cond: (WebSocketUpgradeResponse) => Boolean, msg: => Any): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (WebSocketUpgradeResponse) => Boolean): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): WebSocketUpgradeResponse
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toEnsuring[WebSocketUpgradeResponse] 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toStringFormat[WebSocketUpgradeResponse] 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): (WebSocketUpgradeResponse, B)
- Implicit
- This member is added by an implicit conversion from WebSocketUpgradeResponse toArrowAssoc[WebSocketUpgradeResponse] 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.