29#ifndef WEBSOCKETPP_CLOSE_HPP
30#define WEBSOCKETPP_CLOSE_HPP
36#include <websocketpp/error.hpp>
37#include <websocketpp/common/network.hpp>
38#include <websocketpp/common/stdint.hpp>
39#include <websocketpp/utf8_validator.hpp>
235 return "Normal close";
239 return "Protocol error";
241 return "Unsupported data";
243 return "No status set";
245 return "Abnormal close";
247 return "Invalid payload";
249 return "Policy violoation";
251 return "Message too big";
253 return "Extension required";
255 return "Internal endpoint error";
257 return "Service restart";
259 return "Try again later";
261 return "Bad gateway";
263 return "TLS handshake failure";
265 return "Generic subprotocol error";
267 return "Invalid subprotocol data";
297 ec = lib::error_code();
299 if (payload.size() == 0) {
301 }
else if (payload.size() == 1) {
308 val.c[0] = payload[0];
309 val.c[1] = payload[1];
337 ec = lib::error_code();
339 if (payload.size() > 2) {
340 reason.append(payload.begin()+2,payload.end());
343 if (!websocketpp::utf8_validator::validate(reason)) {
static value const service_restart
static value const message_too_big
An endpoint received a message too large to process.
static value const try_again_later
static value const force_tcp_drop
Close the connection with a forced TCP drop.
static value const tls_handshake
An endpoint failed to perform a TLS handshake.
static value const rsv_end
Last value in range reserved for future protocol use.
static value const invalid_payload
An endpoint received message data inconsistent with its type.
bool terminal(value code)
Determine if the code represents an unrecoverable error.
static value const protocol_error
A protocol error occurred.
std::string get_string(value code)
Return a human readable interpretation of a WebSocket close code.
static value const bad_gateway
static value const invalid_subprotocol_data
A invalid subprotocol data.
static value const invalid_high
Last value in range that is always invalid on the wire.
static value const unsupported_data
static value const no_status
A dummy value to indicate that no status code was received.
static value const omit_handshake
Close the connection without a WebSocket close handshake.
static value const normal
static value const blank
A blank value for internal use.
static value const invalid_low
First value in range that is always invalid on the wire.
static value const abnormal_close
A dummy value to indicate that the connection was closed abnormally.
static value const rsv_start
First value in range reserved for future protocol use.
uint16_t value
The type of a close code value.
static value const policy_violation
An endpoint received a message that violated its policy.
static value const extension_required
A client expected the server to accept a required extension request.
bool invalid(value code)
Test whether a close code is invalid on the wire.
static value const internal_endpoint_error
static value const subprotocol_error
A generic subprotocol error.
bool reserved(value code)
Test whether a close code is in a reserved range.
static value const going_away
std::string extract_reason(std::string const &payload, lib::error_code &ec)
Extract the reason string from a close payload.
status::value extract_code(std::string const &payload, lib::error_code &ec)
Extract a close code value from a close payload.
@ reserved_close_code
Close code is in a reserved range.
@ invalid_utf8
Invalid UTF-8.
@ invalid_close_code
Close code is invalid.
@ bad_close_code
Unable to parse close code.
Namespace for the WebSocket++ project.
Type used to convert close statuses between integer and wire representations.