fm.liveswitch.WebSocketStatusCode Enum Reference

An enumeration of potential WebSocket status codes. More...

Public Member Functions

 WebSocketStatusCode (int value)
 
int getAssignedValue ()
 

Static Public Member Functions

 [static initializer]
 
static WebSocketStatusCode getByAssignedValue (int value)
 

Public Attributes

 Normal =(1000)
 Indicates normal closure, meaning that the purpose for which the connection was established has been fulfilled. More...
 
 GoingAway =(1001)
 Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page. More...
 
 ProtocolError =(1002)
 Indicates that an endpoint is terminating the connection due to a protocol error. More...
 
 InvalidType =(1003)
 Indicates that an endpoint is terminating the connection because it has received a type of data that it cannot accept. More...
 
 NoStatus =(1005)
 Indicates that no status code was present in the Close frame. More...
 
 Abnormal =(1006)
 Indicates that the connection was closed abnormally, without sending a Close frame. More...
 
 InvalidData =(1007)
 Indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of message. More...
 
 PolicyViolation =(1008)
 Indicates that an endpoint is terminating the connection because it has received a message that violates its policy. More...
 
 MessageTooLarge =(1009)
 Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process. More...
 
 UnsupportedExtension =(1010)
 Indicates that the client is terminating the connection because it has expected the server to negotiate one or more extensions, but the server didn't return them in the response message of the WebSocket handshake. More...
 
 UnexpectedCondition =(1011)
 Indicates that the server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request. More...
 
 SecureHandshakeFailure =(1015)
 Indicates that the connection was closed due to a failure to perform a TLS handshake. More...
 
 ClientKeepAliveTimeout =(4000)
 Indicates the connection was closed by the client due to a timeout in the keep alive mechanism. More...
 

Detailed Description

An enumeration of potential WebSocket status codes.

Constructor & Destructor Documentation

◆ WebSocketStatusCode()

fm.liveswitch.WebSocketStatusCode.WebSocketStatusCode ( int  value)

Member Function Documentation

◆ [static initializer]()

fm.liveswitch.WebSocketStatusCode.[static initializer]
static

◆ getAssignedValue()

int fm.liveswitch.WebSocketStatusCode.getAssignedValue ( )

◆ getByAssignedValue()

static WebSocketStatusCode fm.liveswitch.WebSocketStatusCode.getByAssignedValue ( int  value)
static

Member Data Documentation

◆ Abnormal

fm.liveswitch.WebSocketStatusCode.Abnormal =(1006)

Indicates that the connection was closed abnormally, without sending a Close frame.

Reserved for use outside Close frames.

◆ ClientKeepAliveTimeout

fm.liveswitch.WebSocketStatusCode.ClientKeepAliveTimeout =(4000)

Indicates the connection was closed by the client due to a timeout in the keep alive mechanism.

◆ GoingAway

fm.liveswitch.WebSocketStatusCode.GoingAway =(1001)

Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.

◆ InvalidData

fm.liveswitch.WebSocketStatusCode.InvalidData =(1007)

Indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of message.

◆ InvalidType

fm.liveswitch.WebSocketStatusCode.InvalidType =(1003)

Indicates that an endpoint is terminating the connection because it has received a type of data that it cannot accept.

◆ MessageTooLarge

fm.liveswitch.WebSocketStatusCode.MessageTooLarge =(1009)

Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.

◆ Normal

fm.liveswitch.WebSocketStatusCode.Normal =(1000)

Indicates normal closure, meaning that the purpose for which the connection was established has been fulfilled.

◆ NoStatus

fm.liveswitch.WebSocketStatusCode.NoStatus =(1005)

Indicates that no status code was present in the Close frame.

Reserved for use outside Close frames.

◆ PolicyViolation

fm.liveswitch.WebSocketStatusCode.PolicyViolation =(1008)

Indicates that an endpoint is terminating the connection because it has received a message that violates its policy.

◆ ProtocolError

fm.liveswitch.WebSocketStatusCode.ProtocolError =(1002)

Indicates that an endpoint is terminating the connection due to a protocol error.

◆ SecureHandshakeFailure

fm.liveswitch.WebSocketStatusCode.SecureHandshakeFailure =(1015)

Indicates that the connection was closed due to a failure to perform a TLS handshake.

Reserved for use outside Close frames.

◆ UnexpectedCondition

fm.liveswitch.WebSocketStatusCode.UnexpectedCondition =(1011)

Indicates that the server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

◆ UnsupportedExtension

fm.liveswitch.WebSocketStatusCode.UnsupportedExtension =(1010)

Indicates that the client is terminating the connection because it has expected the server to negotiate one or more extensions, but the server didn't return them in the response message of the WebSocket handshake.