Unit
ScWebSocketClient
type
TScWebSocketCloseStatus = (csNormalClosure, csEndpointUnavailable, csProtocolError,
csUnsupportedData, csEmpty, csAbnormalClosure, csInvalidPayloadData,
csPolicyViolation, csMessageTooBig, csMandatoryExtension,
csInternalServerError, csTLSHandshakeError,
csUnknown);
Description
The TScWebSocketCloseStatus enumeration contains the values of the status codes defined in RFC 6455 for WebSocket protocol.
Value |
Description |
---|---|
csNormalClosure |
Equivalent to WebSocket status code 1000. Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled. |
csEndpointUnavailable |
Equivalent to WebSocket status code 1001. Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page. |
csProtocolError |
Equivalent to WebSocket status code 1002. Indicates that an endpoint is terminating the connection due to a protocol error. |
csUnsupportedData |
Equivalent to WebSocket status code 1003. Indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept. |
csEmpty |
Equivalent to WebSocket status code 1005. Indicates that no status code was actually present. |
csAbnormalClosure |
Equivalent to WebSocket status code 1006. Indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame. |
csInvalidPayloadData |
Equivalent to WebSocket status code 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 the message. |
csPolicyViolation |
Equivalent to WebSocket status code 1008. Indicates that an endpoint is terminating the connection because it has received a message that violates its policy. |
csMessageTooBig |
Equivalent to WebSocket status code 1009. Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process. |
csMandatoryExtension |
Equivalent to WebSocket status code 1010. Indicates that an endpoint is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake. |
csInternalServerError |
Equivalent to WebSocket status code 1011. Indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request. |
csTLSHandshakeError |
Equivalent to WebSocket status code 1015. Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified). |
csUnknown |
The specific meaning is not defined. |
See also
TScWebSocketClient.CloseStatus