Symbols

loading...

Files

loading...

Summary Syntax References

SourceVuESP-IDF Framework and ExamplesESP-IDFhttpd_req_aux

httpd_req_aux struct

Auxiliary data structure for use during reception and processing of requests and temporarily keeping responses

Syntax

Show:

Summary

Declaration

from esp_httpd_priv.h:89

struct httpd_req_aux { struct sock_db *sd; char scratch[HTTPD_SCRATCH_BUF + 1]; size_t remaining_len; char *status; char *content_type; bool first_chunk_sent; unsigned req_hdrs_count; unsigned resp_hdrs_count; struct resp_hdr { const char *field; const char *value; } *resp_hdrs; struct http_parser_url url_parse_res; #ifdef CONFIG_HTTPD_WS_SUPPORT bool ws_handshake_detect; httpd_ws_type_t ws_type; bool ws_final; uint8_t mask_key[4]; #endif };

Fields

Field

Declared as

Description

httpd_req_aux::sd

struct sock_db *

Pointer to socket database.

httpd_req_aux::scratch

char[HTTPD_SCRATCH_BUF + 1]

Temporary buffer for our operations (1 byte extra for null termination).

httpd_req_aux::remaining_len

size_t

Amount of data remaining to be fetched.

httpd_req_aux::status

char *

HTTP response's status code.

httpd_req_aux::content_type

char *

HTTP response's content type.

httpd_req_aux::first_chunk_sent

bool

Used to indicate if first chunk sent.

httpd_req_aux::req_hdrs_count

unsigned

Count of total headers in request packet.

httpd_req_aux::resp_hdrs_count

unsigned

Count of additional headers in response packet.

httpd_req_aux::resp_hdrs

struct resp_hdr { const char *field; const char *value; } *

Additional headers in response packet.

httpd_req_aux::url_parse_res

struct http_parser_url

URL parsing result, used for retrieving URL elements.

httpd_req_aux::ws_handshake_detect

bool

WebSocket handshake detection flag.

httpd_req_aux::ws_type

httpd_ws_type_t

WebSocket frame type.

httpd_req_aux::ws_final

bool

WebSocket FIN bit (final frame or not).

httpd_req_aux::mask_key

uint8_t[4]

WebSocket mask key for this payload.

Examples

References

from examples