module Mongrel2::WebSocket::Constants
WebSocket-related header and status constants
Constants
- CLOSE_ABNORMAL_STATUS
1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame.
- CLOSE_BAD_DATA
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 (e.g., non-UTF-8 [RFC3629] data within a text message).
- CLOSE_BAD_DATA_TYPE
1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).
- CLOSE_EXCEPTION
1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
- CLOSE_GOING_AWAY
1001 indicates that an endpoint is “going away”, such as a server going down or a browser having navigated away from a page.
- CLOSE_MESSAGE_TOO_LARGE
1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
- CLOSE_MISSING_EXTENSION
1010 indicates that an endpoint (client) 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. The list of extensions that are needed SHOULD appear in the /reason/ part of the Close frame. Note that this status code is not used by the server, because it can fail theWebSocket
handshake instead.- CLOSE_MISSING_STATUS
1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that no status code was actually present.
- CLOSE_NORMAL
1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.
- CLOSE_POLICY_VIOLATION
1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy. This is a generic status code that can be returned when there is no other more suitable status code (e.g., 1003 or 1009) or if there is a need to hide specific details about the policy.
- CLOSE_PROTOCOL_ERROR
1002 indicates that an endpoint is terminating the connection due to a protocol error.
- CLOSE_RESERVED
Reserved. The specific meaning might be defined in the future.
- CLOSE_TLS_ERROR
1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).
- CLOSING_STATUS_DESC
Human-readable messages for each closing status code.
- DEFAULT_CHUNKSIZE
The default number of bytes to write out to Mongrel for a single “chunk”
- FIN_FLAG
Masks of the bits of the FLAGS header that corresponds to the FIN and RSV1-3 flags
- OPCODE
Opcode bits keyed by name
- OPCODE_BITMASK
Mask for picking the opcode out of the flags header
- OPCODE_CONTROL_MASK
Mask for testing to see if the frame is a control frame
- OPCODE_NAME
Opcodes from the flags header
- RSV1_FLAG
- RSV2_FLAG
- RSV3_FLAG
- RSV_FLAG_MASK
Mask for checking for one or more of the RSV flags