Symbols ![]()
loading...
Files ![]()
loading...
sock_db struct
A database of all the open sockets in the system.
Syntax
struct sock_db
{
int fd;
void *ctx;
bool ignore_sess_ctx_changes;
void *transport_ctx;
httpd_handle_t handle;
httpd_free_ctx_fn_t free_ctx;
httpd_free_ctx_fn_t free_transport_ctx;
httpd_send_func_t send_fn;
httpd_recv_func_t recv_fn;
httpd_pending_func_t pending_fn;
uint64_t lru_counter;
bool lru_socket;
char pending_data[PARSER_BLOCK_SIZE];
size_t pending_len;
bool for_async_req;
#ifdef CONFIG_HTTPD_WS_SUPPORT
bool ws_handshake_done;
bool ws_close;
esp_err_t (*ws_handler)(httpd_req_t *r);
bool ws_control_frames;
void *ws_user_ctx;
#endif
};
Fields
Field
Declared as
Description
void *
A custom 'transport' context for this socket, to be used by send/recv/pending.
bool
True if it has done WebSocket handshake (if this socket is a valid WS).
WebSocket handler, leave to null if it's not WebSocket.
bool
WebSocket flag indicating that control frames should be passed to user handlers.
void *
Pointer to user context data which will be available to handler for websocket.
Related Functions
Found 8 other functions taking a sock_db
argument:
Function
Description
Remove client descriptor from the session / socket database and close the connection for this client.
Trigger an httpd session close externally
Processes incoming HTTP requests
Checks if session has any pending data/packets for processing This is needed as httpd_unrecv may un-receive next packet in the stream. If only partial packet was received then select() would mark the fd for processing as remaining part of the packet would still be in socket recv queue. But if a complete packet got unreceived then it would not be processed until further data is received on the socket. This is when this function comes in use, as it checks the socket's pending data buffer.
Initiates the processing of HTTP request Receives incoming TCP packet on a socket, then parses the packet as HTTP request and fills httpd_req_t data structure with the extracted URI, headers are ready to be fetched from scratch buffer and calling http_recv() after this reads the body of the request.