abstract class WebSocketCloseException extends RuntimeException
Fail the outgoing message stream of a WebSocket handler with a WebSocketCloseException to close the WebSocket
with an application specific close code (3000-4999) and reason. The peer will see the close code and reason
(in Akka HTTP as a PeerClosedConnectionException).
Note that failing a stream may discard messages buffered in stages downstream of the failing stage. An ongoing streamed message is given the close timeout (3 seconds) to finish before the WebSocket is closed.
Create instances using create.
- Annotations
- @DoNotInherit()
- Source
- WebSocketCloseException.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- WebSocketCloseException
- RuntimeException
- Exception
- Throwable
- Serializable
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
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 WebSocketCloseException toany2stringadd[WebSocketCloseException] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (WebSocketCloseException, B)
- Implicit
- This member is added by an implicit conversion from WebSocketCloseException toArrowAssoc[WebSocketCloseException] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def addSuppressed(arg0: Throwable): Unit
- Definition Classes
- Throwable
- 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()
- val closeCode: Int
- val closeReason: String
- def ensuring(cond: (WebSocketCloseException) => Boolean, msg: => Any): WebSocketCloseException
- Implicit
- This member is added by an implicit conversion from WebSocketCloseException toEnsuring[WebSocketCloseException] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (WebSocketCloseException) => Boolean): WebSocketCloseException
- Implicit
- This member is added by an implicit conversion from WebSocketCloseException toEnsuring[WebSocketCloseException] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): WebSocketCloseException
- Implicit
- This member is added by an implicit conversion from WebSocketCloseException toEnsuring[WebSocketCloseException] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): WebSocketCloseException
- Implicit
- This member is added by an implicit conversion from WebSocketCloseException toEnsuring[WebSocketCloseException] 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 fillInStackTrace(): Throwable
- Definition Classes
- Throwable
- def getCause(): Throwable
- Definition Classes
- Throwable
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getLocalizedMessage(): String
- Definition Classes
- Throwable
- def getMessage(): String
- Definition Classes
- Throwable
- def getStackTrace(): Array[StackTraceElement]
- Definition Classes
- Throwable
- final def getSuppressed(): Array[Throwable]
- Definition Classes
- Throwable
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def initCause(arg0: Throwable): Throwable
- Definition Classes
- Throwable
- 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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def printStackTrace(arg0: PrintWriter): Unit
- Definition Classes
- Throwable
- def printStackTrace(arg0: PrintStream): Unit
- Definition Classes
- Throwable
- def printStackTrace(): Unit
- Definition Classes
- Throwable
- def setStackTrace(arg0: Array[StackTraceElement]): Unit
- Definition Classes
- Throwable
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Throwable → AnyRef → Any
- 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 WebSocketCloseException toStringFormat[WebSocketCloseException] 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): (WebSocketCloseException, B)
- Implicit
- This member is added by an implicit conversion from WebSocketCloseException toArrowAssoc[WebSocketCloseException] 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.