websocketpp::close::status Namespace Reference

A package of types and methods for manipulating WebSocket close status'.

Typedefs
typedef uint16_t	value
	The type of a close code value.

Functions
bool	reserved (value code)
	Test whether a close code is in a reserved range.
bool	invalid (value code)
	Test whether a close code is invalid on the wire.
bool	terminal (value code)
	Determine if the code represents an unrecoverable error.
std::string	get_string (value code)
	Return a human readable interpretation of a WebSocket close code.

Typedef Documentation

value

typedef uint16_t websocketpp::close::status::value

Definition at line 49 of file close.hpp.

Function Documentation

get_string()

std::string websocketpp::close::status::get_string ( value code )

inline

See https://tools.ietf.org/html/rfc6455#section-7.4 for more details.

Since

0.3.0

Parameters

[in]

code

The code to look up.

Returns

A human readable interpretation of the code.

Definition at line 227 of file close.hpp.

                                            {
        switch (code) {
            case normal:
                return "Normal close";
            case going_away:
                return "Going away";
            case protocol_error:
                return "Protocol error";
            case unsupported_data:
                return "Unsupported data";
            case no_status:
                return "No status set";
            case abnormal_close:
                return "Abnormal close";
            case invalid_payload:
                return "Invalid payload";
            case policy_violation:
                return "Policy violoation";
            case message_too_big:
                return "Message too big";
            case extension_required:
                return "Extension required";
            case internal_endpoint_error:
                return "Internal endpoint error";
            case tls_handshake:
                return "TLS handshake failure";
            case subprotocol_error:
                return "Generic subprotocol error";
            case invalid_subprotocol_data:
                return "Invalid subprotocol data";
            default:
                return "Unknown";
        }
    }

Here is the caller graph for this function:

invalid()

bool websocketpp::close::status::invalid ( value code )

inline

Parameters

[in]

code

The code to test

Returns

Whether or not code is invalid on the wire

Definition at line 194 of file close.hpp.

                                    {
        return (code <= invalid_low || code >= invalid_high ||
                code == no_status || code == abnormal_close ||
                code == tls_handshake);
    }

Here is the caller graph for this function:

reserved()

bool websocketpp::close::status::reserved ( value code )

inline

Parameters

[in]

code

The code to test

Returns

Whether or not code is reserved

Definition at line 179 of file close.hpp.

                                     {
        return ((code >= rsv_start && code <= rsv_end) ||
                code == 1004 || code == 1014);
    }

Here is the caller graph for this function:

terminal()

bool websocketpp::close::status::terminal ( value code )

inline

There is a class of errors for which once they are discovered normal WebSocket functionality can no longer occur. This function determines if a given code is one of these values. This information is used to determine if the system has the capability of waiting for a close acknowledgement or if it should drop the TCP connection immediately after sending its close frame.

Parameters

[in]

code

The value to test.

Returns

True if the code represents an unrecoverable error

Definition at line 212 of file close.hpp.

                                     {
        return (code == protocol_error || code == invalid_payload ||
                code == policy_violation || code == message_too_big ||
                 code == internal_endpoint_error);
    }

Here is the caller graph for this function: