include/ws.h file

Classes

struct ws_events

events Web Socket events types.

Functions

auto get_handshake_accept(char* wsKey, unsigned char** dest) -> int

Gets the field Sec-WebSocket-Accept on response, by an previously informed key.

auto get_handshake_response(char* hsrequest, char** hsresponse) -> int

Gets the complete response to accomplish a succesfully handshake.

auto ws_getaddress(ws_cli_conn_t* client) -> char*

Gets the IP address relative to a client connection opened by the server.

auto ws_sendframe(ws_cli_conn_t* cli, const char* msg, uint64_t size, int type) -> int

Creates and send an WebSocket frame with some payload data.

auto ws_sendframe_txt(ws_cli_conn_t* cli, const char* msg) -> int

Sends a WebSocket text frame.

auto ws_sendframe_bin(ws_cli_conn_t* cli, const char* msg, uint64_t size) -> int

Sends a WebSocket binary frame.

auto ws_get_state(ws_cli_conn_t* cli) -> int

For a given client, gets the current state for the connection, or -1 if invalid.

auto ws_close_client(ws_cli_conn_t* cli) -> int

Close the client connection for the given client with normal close code (1000) and no reason string.

auto ws_socket(struct ws_events* evs, uint16_t port, int thread_loop) -> int

Main loop for the server.

Defines

#define WS_CLSE_INVUTF8

Inconsistent message (invalid utf-8)

Global configurations

#define MAX_CLIENTS

Max clients connected simultaneously.

Key and message configurations.

#define MESSAGE_LENGTH

Message buffer length.

#define MAX_FRAME_LENGTH

Maximum frame/message length.

#define WS_KEY_LEN

WebSocket key length.

#define WS_MS_LEN

Magic string length.

#define WS_KEYMS_LEN

Accept message response length.

#define MAGIC_STRING

Magic string.

Handshake constants.

#define WS_HS_REQ

Alias for 'Sec-WebSocket-Key'.

#define WS_HS_ACCLEN

Handshake accept message length.

#define WS_HS_ACCEPT

Handshake accept message.

#define DEBUG(...)

Debug.

Frame types.

#define WS_FIN

Frame FIN.

#define WS_FIN_SHIFT

Frame FIN shift.

#define WS_FR_OP_CONT

Continuation frame.

#define WS_FR_OP_TXT

Text frame.

#define WS_FR_OP_BIN

Binary frame.

#define WS_FR_OP_CLSE

Close frame.

#define WS_FR_OP_PING

Ping frame.

#define WS_FR_OP_PONG

Pong frame.

#define WS_FR_OP_UNSUPPORTED

Unsupported frame.

Close codes

#define WS_CLSE_NORMAL

Normal close.

#define WS_CLSE_PROTERR

Protocol error.

Connection states

#define WS_STATE_CONNECTING

Connection not established yet.

#define WS_STATE_OPEN

Communicating.

#define WS_STATE_CLOSING

Closing state.

#define WS_STATE_CLOSED

Closed.

Timeout util

#define MS_TO_NS(x)

Nanoseconds macro converter.

#define TIMEOUT_MS

Timeout in milliseconds.

Function documentation