_WebSocket Struct Reference

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...
 
NetInterfaceinterface
 Underlying network interface. More...
 
Socketsocket
 Underlying TCP socket. More...
 
TlsContexttlsContext
 TLS context. More...
 
TlsSessionState tlsSession
 TLS session state. More...
 
WebSocketTlsInitCallback tlsInitCallback
 TLS initialization callback function. More...
 
WebSocketAuthContext authContext
 
WebSocketHandshakeContext handshakeContext
 
WebSocketFrameContext txContext
 
WebSocketFrameContext rxContext
 
WebSocketUtf8Context utf8Context
 

Detailed Description

Structure describing a WebSocket.

Definition at line 426 of file web_socket.h.

Field Documentation

◆ authContext

WebSocketAuthContext authContext

Definition at line 447 of file web_socket.h.

◆ endpoint

Endpoint type (client or server)

Definition at line 428 of file web_socket.h.

◆ handshakeContext

WebSocketHandshakeContext handshakeContext

Definition at line 449 of file web_socket.h.

◆ host

Domain name of the server (for virtual hosting)

Definition at line 433 of file web_socket.h.

◆ interface

NetInterface* interface

Underlying network interface.

Definition at line 439 of file web_socket.h.

◆ origin

Definition at line 434 of file web_socket.h.

◆ queryString

Definition at line 437 of file web_socket.h.

◆ retryCount

uint_t retryCount

Definition at line 432 of file web_socket.h.

◆ rxContext

Definition at line 451 of file web_socket.h.

◆ socket

Socket* socket

Underlying TCP socket.

Definition at line 440 of file web_socket.h.

◆ state

WebSocket connection state.

Definition at line 429 of file web_socket.h.

◆ statusCode

uint16_t statusCode

Definition at line 430 of file web_socket.h.

◆ subProtocol

Definition at line 435 of file web_socket.h.

◆ timeout

systime_t timeout

timeout value for blocking operations

Definition at line 438 of file web_socket.h.

◆ timestamp

systime_t timestamp

Definition at line 431 of file web_socket.h.

◆ tlsContext

TlsContext* tlsContext

TLS context.

Definition at line 442 of file web_socket.h.

◆ tlsInitCallback

WebSocketTlsInitCallback tlsInitCallback

TLS initialization callback function.

Definition at line 444 of file web_socket.h.

◆ tlsSession

TlsSessionState tlsSession

TLS session state.

Definition at line 443 of file web_socket.h.

◆ txContext

Definition at line 450 of file web_socket.h.

◆ uri

Definition at line 436 of file web_socket.h.

◆ utf8Context

WebSocketUtf8Context utf8Context

Definition at line 452 of file web_socket.h.


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