Structure describing a WebSocket. More...

#include <web_socket.h>

Data Fields
WebSocketEndpoint	endpoint
	Endpoint type (client or server) More...

WebSocketState	state
	WebSocket connection state. More...

uint16_t	statusCode

systime_t	timestamp

uint_t	retryCount

char_t	host [WEB_SOCKET_HOST_MAX_LEN+1]
	Domain name of the server (for virtual hosting) More...

char_t	origin [WEB_SOCKET_ORIGIN_MAX_LEN+1]

char_t	subProtocol [WEB_SOCKET_SUB_PROTOCOL_MAX_LEN+1]

char_t	uri [WEB_SOCKET_URI_MAX_LEN+1]

char_t	queryString [WEB_SOCKET_QUERY_STRING_MAX_LEN+1]

systime_t	timeout
	timeout value for blocking operations More...

NetInterface *	interface
	Underlying network interface. More...

Socket *	socket
	Underlying TCP socket. More...

TlsContext *	tlsContext
	TLS context. More...

TlsSessionState	tlsSession
	TLS session state. More...

WebSocketTlsInitCallback	tlsInitCallback
	TLS initialization callback function. More...

void *	tlsInitParam
	Opaque pointer passed to the TLS initialization callback function. More...

WebSocketAuthContext	authContext

WebSocketHandshakeContext	handshakeContext

WebSocketFrameContext	txContext

WebSocketFrameContext	rxContext

WebSocketUtf8Context	utf8Context

Detailed Description

Structure describing a WebSocket.

Definition at line 430 of file web_socket.h.

Field Documentation

◆ authContext

WebSocketAuthContext authContext

Definition at line 452 of file web_socket.h.

◆ endpoint

WebSocketEndpoint endpoint

Endpoint type (client or server)

Definition at line 432 of file web_socket.h.

◆ handshakeContext

WebSocketHandshakeContext handshakeContext

Definition at line 454 of file web_socket.h.

◆ host

char_t host[WEB_SOCKET_HOST_MAX_LEN+1]

Domain name of the server (for virtual hosting)

Definition at line 437 of file web_socket.h.

◆ interface

NetInterface* interface

Underlying network interface.

Definition at line 443 of file web_socket.h.

◆ origin

char_t origin[WEB_SOCKET_ORIGIN_MAX_LEN+1]

Definition at line 438 of file web_socket.h.

◆ queryString

char_t queryString[WEB_SOCKET_QUERY_STRING_MAX_LEN+1]

Definition at line 441 of file web_socket.h.

◆ retryCount

uint_t retryCount

Definition at line 436 of file web_socket.h.

◆ rxContext

WebSocketFrameContext rxContext

Definition at line 456 of file web_socket.h.

◆ socket

Socket* socket

Underlying TCP socket.

Definition at line 444 of file web_socket.h.

◆ state

WebSocketState state

WebSocket connection state.

Definition at line 433 of file web_socket.h.

◆ statusCode

uint16_t statusCode

Definition at line 434 of file web_socket.h.

◆ subProtocol

char_t subProtocol[WEB_SOCKET_SUB_PROTOCOL_MAX_LEN+1]

Definition at line 439 of file web_socket.h.

◆ timeout

systime_t timeout

timeout value for blocking operations

Definition at line 442 of file web_socket.h.

◆ timestamp

systime_t timestamp

Definition at line 435 of file web_socket.h.

◆ tlsContext

TlsContext* tlsContext

TLS context.

Definition at line 446 of file web_socket.h.

◆ tlsInitCallback

WebSocketTlsInitCallback tlsInitCallback

TLS initialization callback function.

Definition at line 448 of file web_socket.h.

◆ tlsInitParam

void* tlsInitParam

Opaque pointer passed to the TLS initialization callback function.

Definition at line 449 of file web_socket.h.

◆ tlsSession

TlsSessionState tlsSession

TLS session state.

Definition at line 447 of file web_socket.h.

◆ txContext

WebSocketFrameContext txContext

Definition at line 455 of file web_socket.h.

◆ uri

char_t uri[WEB_SOCKET_URI_MAX_LEN+1]

Definition at line 440 of file web_socket.h.

◆ utf8Context

WebSocketUtf8Context utf8Context

Definition at line 457 of file web_socket.h.

The documentation for this struct was generated from the following file:

cyclone_tcp/web_socket/web_socket.h

Data Fields