TransportErrorCode

An error code that gets translated into an appropriate underlying error code.

This attempts to match up corresponding HTTP error codes with WebSocket close codes, so that user code can generically select a code without worrying about the underlying transport.

While most WebSocket close codes that we typically use do have a corresponding HTTP error code, there are many HTTP error codes that don't have a corresponding WebSocket close code. In these cases, we use the private WebSocket close code range (4xxx), with the HTTP error code as the last three digits. Such WebSocket close codes will be in the range 4400 to 4599.

This class should only be used to represent error codes, status codes like HTTP 200 should not be represented using this class. This is enforced for HTTP codes, since they have a well defined categorisation, codes between 400 and 599 are considered errors. It is however not enforced for WebSockets, since the WebSocket protocol defines no such categorisation of codes, it specifies a number of well known codes from 1000 to 1015, with no particular pattern to their meaning, and the remaining codes are only categorised by whether they are private, reserved for the WebSocket spec, or reserved for applications to specify.

For WebSocket close codes that are not known, or are not in the private range of 4400 to 4599 defined by us, this use class uses the generic HTTP 404 error code.

Source: Exceptions.scala

Linear Supertypes

Serializable, AnyRef, Any

Abstract Value Members

abstract val description: String

A description of this close code.
A description of this close code.
This description will be meaningful for known built in close codes, but for other codes, it will be Unknown error code
returns
A description of this closed code.
abstract val http: Int

The HTTP status code for this error.
abstract val webSocket: Int

The WebSocket close code for this error.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from TransportErrorCode to any2stringadd[TransportErrorCode] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (TransportErrorCode, B)

Implicit information
This member is added by an implicit conversion from TransportErrorCode to ArrowAssoc[TransportErrorCode] 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
@throws( ... )
def ensuring(cond: (TransportErrorCode) ⇒ Boolean, msg: ⇒ Any): TransportErrorCode

Implicit information
This member is added by an implicit conversion from TransportErrorCode to Ensuring[TransportErrorCode] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (TransportErrorCode) ⇒ Boolean): TransportErrorCode

Implicit information
This member is added by an implicit conversion from TransportErrorCode to Ensuring[TransportErrorCode] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): TransportErrorCode

Implicit information
This member is added by an implicit conversion from TransportErrorCode to Ensuring[TransportErrorCode] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): TransportErrorCode

Implicit information
This member is added by an implicit conversion from TransportErrorCode to Ensuring[TransportErrorCode] 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 information
This member is added by an implicit conversion from TransportErrorCode to StringFormat[TransportErrorCode] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (TransportErrorCode, B)

Implicit information
This member is added by an implicit conversion from TransportErrorCode to ArrowAssoc[TransportErrorCode] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object TransportErrorCode | package transport

sealed trait TransportErrorCode extends Serializable

Abstract Value Members

abstract val description: String

abstract val http: Int

abstract val webSocket: Int

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (TransportErrorCode, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (TransportErrorCode) ⇒ Boolean, msg: ⇒ Any): TransportErrorCode

def ensuring(cond: (TransportErrorCode) ⇒ Boolean): TransportErrorCode

def ensuring(cond: Boolean, msg: ⇒ Any): TransportErrorCode

def ensuring(cond: Boolean): TransportErrorCode

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (TransportErrorCode, B)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TransportErrorCode to any2stringadd[TransportErrorCode]

Inherited by implicit conversion StringFormat from TransportErrorCode to StringFormat[TransportErrorCode]

Inherited by implicit conversion Ensuring from TransportErrorCode to Ensuring[TransportErrorCode]

Inherited by implicit conversion ArrowAssoc from TransportErrorCode to ArrowAssoc[TransportErrorCode]

Ungrouped