GNU libmicrohttpd 1.0.1
Loading...
Searching...
No Matches
MHD_Request Struct Reference

#include </builddir/build/BUILD/libmicrohttpd-1.0.1-build/libmicrohttpd-1.0.1/src/lib/internal.h>

Data Fields

struct MHD_Daemondaemon
 
struct MHD_Connectionconnection
 
struct MHD_Responseresponse
 
struct MHD_HTTP_Headerheaders_received
 
struct MHD_HTTP_Headerheaders_received_tail
 
void * client_context
 
char * method_s
 
const char * url
 
char * version_s
 
enum MHD_ConnKeepAlive keepalive
 
char * read_buffer
 
char * write_buffer
 
char * last
 
char * colon
 
size_t read_buffer_size
 
size_t read_buffer_offset
 
size_t write_buffer_size
 
size_t write_buffer_send_offset
 
size_t write_buffer_append_offset
 
size_t header_size
 
uint64_t remaining_upload_size
 
uint64_t current_chunk_size
 
uint64_t current_chunk_offset
 
uint64_t response_write_position
 
size_t continue_message_write_offset
 
enum MHD_REQUEST_STATE state
 
enum MHD_Method method
 
enum MHD_RequestEventLoopInfo event_loop_info
 
bool in_idle
 
bool in_cleanup
 
bool have_chunked_upload
 
const char * version
 
enum MHD_HTTP_Version http_ver
 
const char * method
 
enum MHD_HTTP_Method http_mthd
 
size_t url_len
 
size_t req_target_len
 
struct MHD_HTTP_Req_Headerheaders_received
 
struct MHD_HTTP_Req_Headerheaders_received_tail
 
union MHD_StartOrSize field_lines
 
bool some_payload_processed
 
bool client_aware
 
size_t num_cr_sp_replaced
 
size_t skipped_broken_lines
 
union MHD_HeadersProcessing hdrs
 

Detailed Description

State kept for each HTTP request.

Request-specific values.

Meaningful for the current request only.

Definition at line 366 of file internal.h.

Field Documentation

◆ client_aware

bool MHD_Request::client_aware

Did we ever call the "default_handler" on this request? This flag determines if we have called the MHD_OPTION_NOTIFY_COMPLETED handler when the request finishes.

Definition at line 1199 of file internal.h.

Referenced by call_connection_handler(), connection_reset(), MHD_connection_close_(), process_request_body(), process_request_target(), and resume_suspended_connections().

◆ client_context

void * MHD_Request::client_context

We allow the main application to associate some pointer with the HTTP request, which is passed to each MHD_AccessHandlerCallback and some other API calls. Here is where we store it. (MHD does not know or care what it is).

Definition at line 401 of file internal.h.

Referenced by call_connection_handler(), connection_reset(), MHD_connection_close_(), MHD_request_get_information_sz(), MHD_request_handle_idle_(), MHD_resume_suspended_connections_(), parse_initial_message_line(), process_request_body(), process_request_body(), process_request_target(), resume_suspended_connections(), and thread_main_handle_connection().

◆ colon

char* MHD_Request::colon

Position after the colon on the last incomplete header line during parsing of headers. Allocated in pool. Only valid if state is either MHD_REQUEST_HEADER_PART_RECEIVED or MHD_REQUEST_FOOTER_PART_RECEIVED.

Definition at line 456 of file internal.h.

Referenced by MHD_request_handle_idle_(), process_broken_line(), and process_header_line().

◆ connection

◆ continue_message_write_offset

size_t MHD_Request::continue_message_write_offset

Position in the 100 CONTINUE message that we need to send when receiving http 1.1 requests.

Definition at line 544 of file internal.h.

Referenced by MHD_request_handle_idle_(), MHD_request_handle_write_(), and need_100_continue().

◆ current_chunk_offset

uint64_t MHD_Request::current_chunk_offset

If we are receiving with chunked encoding, where are we currently with respect to the current chunk (at what offset / position)?

Definition at line 522 of file internal.h.

Referenced by check_and_grow_read_buffer_space(), handle_recv_no_space(), has_unprocessed_upload_body_data_in_buffer(), process_request_body(), and process_request_body().

◆ current_chunk_size

uint64_t MHD_Request::current_chunk_size

If we are receiving with chunked encoding, where are we right now? Set to 0 if we are waiting to receive the chunk size; otherwise, this is the size of the current chunk. A value of zero is also used when we're at the end of the chunks.

Definition at line 516 of file internal.h.

Referenced by check_and_grow_read_buffer_space(), handle_recv_no_space(), has_unprocessed_upload_body_data_in_buffer(), process_request_body(), and process_request_body().

◆ daemon

◆ event_loop_info

enum MHD_RequestEventLoopInfo MHD_Request::event_loop_info

◆ field_lines

union MHD_StartOrSize MHD_Request::field_lines

The union of the size of all request field lines (headers) and the starting point of the first request field line (the first header). Until MHD_CONNECTION_HEADERS_RECEIVED the start member is valid, staring with MHD_CONNECTION_HEADERS_RECEIVED the size member is valid. The size includes CRLF (or LR) characters, but does not include the terminating empty line.

Definition at line 1134 of file internal.h.

Referenced by get_no_space_err_status_code(), get_req_headers(), and switch_to_rq_headers_processing().

◆ have_chunked_upload

bool MHD_Request::have_chunked_upload

Are we receiving with chunked encoding? This will be set to MHD_YES after we parse the headers and are processing the body with chunks. After we are done with the body and we are processing the footers; once the footers are also done, this will be set to MHD_NO again (before the final call to the handler).

Are we receiving with chunked encoding? This will be set to MHD_YES after we parse the headers and are processing the body with chunks. After we are done with the body and we are processing the footers; once the footers are also done, this will be set to MHD_NO again (before the final call to the handler). It is used only for requests, chunked encoding for response is indicated by rp_props.

Definition at line 580 of file internal.h.

Referenced by build_header_response(), check_and_grow_read_buffer_space(), handle_recv_no_space(), handle_req_footers_no_space(), has_unprocessed_upload_body_data_in_buffer(), MHD_connection_handle_idle(), MHD_connection_update_event_loop_info(), MHD_request_handle_idle_(), parse_connection_headers(), parse_request_headers(), process_request_body(), and process_request_body().

◆ hdrs

union MHD_HeadersProcessing MHD_Request::hdrs

◆ header_size

size_t MHD_Request::header_size

Number of bytes we had in the HTTP header, set once we pass MHD_REQUEST_HEADERS_RECEIVED.

Number of bytes we had in the HTTP header, set once we pass MHD_CONNECTION_HEADERS_RECEIVED. This includes the request line, all request headers, the header section terminating empty line, with all CRLF (or LF) characters.

Definition at line 502 of file internal.h.

Referenced by get_req_headers(), MHD_get_connection_info(), MHD_request_get_information_sz(), and MHD_request_handle_idle_().

◆ headers_received [1/2]

◆ headers_received [2/2]

struct MHD_HTTP_Req_Header* MHD_Request::headers_received

Linked list of parsed headers.

Definition at line 1111 of file internal.h.

◆ headers_received_tail [1/2]

struct MHD_HTTP_Header* MHD_Request::headers_received_tail

Tail of linked list of parsed headers.

Definition at line 393 of file internal.h.

Referenced by get_req_headers(), MHD_request_set_value(), MHD_set_connection_value_n_nocheck_(), and transmit_error_response_len().

◆ headers_received_tail [2/2]

struct MHD_HTTP_Req_Header* MHD_Request::headers_received_tail

Tail of linked list of parsed headers.

Definition at line 1116 of file internal.h.

◆ http_mthd

◆ http_ver

◆ in_cleanup

bool MHD_Request::in_cleanup

Are we currently inside the "idle" handler (to avoid recursively invoking it).

Definition at line 571 of file internal.h.

Referenced by cleanup_connection().

◆ in_idle

bool MHD_Request::in_idle

Are we currently inside the "idle" handler (to avoid recursively invoking it).

Definition at line 565 of file internal.h.

Referenced by cleanup_connection(), MHD_request_handle_idle_(), and response_action().

◆ keepalive

enum MHD_ConnKeepAlive MHD_Request::keepalive

Close connection after sending response? Functions may change value from "Unknown" or "KeepAlive" to "Must close", but no functions reset value "Must Close" to any other value.

Definition at line 426 of file internal.h.

Referenced by build_header_response(), keepalive_possible(), MHD_request_handle_idle_(), and transmit_error_response().

◆ last

char* MHD_Request::last

Last incomplete header line during parsing of headers. Allocated in pool. Only valid if state is either MHD_REQUEST_HEADER_PART_RECEIVED or MHD_REQUEST_FOOTER_PART_RECEIVED.

Definition at line 447 of file internal.h.

Referenced by MHD_request_handle_idle_(), process_broken_line(), and process_header_line().

◆ method [1/2]

◆ method [2/2]

const char* MHD_Request::method

Request method. Should be GET/POST/etc. Allocated in pool.

Definition at line 1085 of file internal.h.

◆ method_s

char* MHD_Request::method_s

Request method as string. Should be GET/POST/etc. Allocated in pool.

Definition at line 407 of file internal.h.

Referenced by MHD_request_get_information_sz(), and parse_initial_message_line().

◆ num_cr_sp_replaced

size_t MHD_Request::num_cr_sp_replaced

Number of bare CR characters that were replaced with space characters in the request line or in the headers (field lines).

Definition at line 1231 of file internal.h.

Referenced by get_req_header(), get_req_headers(), get_request_line_inner(), and MHD_connection_handle_idle().

◆ read_buffer

char* MHD_Request::read_buffer

Buffer for reading requests. Allocated in pool. Actually one byte larger than read_buffer_size (if non-NULL) to allow for 0-termination.

Definition at line 433 of file internal.h.

Referenced by get_next_header_line(), MHD_request_handle_idle_(), MHD_request_handle_read_(), process_request_body(), and try_grow_read_buffer().

◆ read_buffer_offset

size_t MHD_Request::read_buffer_offset

Position where we currently append data in read_buffer (last valid position).

Definition at line 480 of file internal.h.

Referenced by connection_update_event_loop_info(), get_next_header_line(), MHD_request_handle_idle_(), MHD_request_handle_read_(), and process_request_body().

◆ read_buffer_size

size_t MHD_Request::read_buffer_size

Size of read_buffer (in bytes). This value indicates how many bytes we're willing to read into the buffer; the real buffer is one byte longer to allow for adding zero-termination (when needed).

Definition at line 474 of file internal.h.

Referenced by connection_update_event_loop_info(), get_next_header_line(), MHD_request_handle_idle_(), MHD_request_handle_read_(), and try_grow_read_buffer().

◆ remaining_upload_size

◆ req_target_len

size_t MHD_Request::req_target_len

◆ response

◆ response_write_position

uint64_t MHD_Request::response_write_position

Current write position in the actual response (excluding headers, content only; should be 0 while sending headers).

Definition at line 529 of file internal.h.

Referenced by MHD_request_handle_idle_(), MHD_request_handle_write_(), response_action(), try_ready_chunked_body(), and try_ready_normal_body().

◆ skipped_broken_lines

size_t MHD_Request::skipped_broken_lines

The number of header lines skipped because they have no colon

Definition at line 1236 of file internal.h.

Referenced by get_req_header(), get_req_headers(), and MHD_connection_handle_idle().

◆ some_payload_processed

bool MHD_Request::some_payload_processed

Indicate that some of the upload payload data (from the currently processed chunk for chunked uploads) have been processed by the last call of the connection handler. If any data have been processed, but some data left in the buffer for further processing, then MHD will use zero timeout before the next data processing round. This allow the application handler process the data by the fixed portions or other way suitable for application developer. If no data have been processed, than MHD will wait for more data to come (as it makes no sense to call the same connection handler under the same conditions). However this is dangerous as if buffer is completely used then connection is aborted. Connection suspension should be used in such case.

Definition at line 1184 of file internal.h.

Referenced by handle_recv_no_space(), MHD_connection_update_event_loop_info(), and process_request_body().

◆ state

◆ url

◆ url_len

size_t MHD_Request::url_len

The length of the url in characters, not including the terminating zero.

Definition at line 1101 of file internal.h.

Referenced by calculate_add_nonce(), check_uri_match(), digest_auth_check_all_inner(), get_request_line(), get_request_line_inner(), process_request_target(), and transmit_error_response_len().

◆ version

const char* MHD_Request::version

HTTP version string (i.e. http/1.1). Allocated in pool.

Definition at line 1075 of file internal.h.

Referenced by call_connection_handler(), get_req_headers(), get_request_line(), get_request_line_inner(), process_request_body(), process_request_body(), and transmit_error_response_len().

◆ version_s

char* MHD_Request::version_s

◆ write_buffer

char* MHD_Request::write_buffer

Buffer for writing response (headers only). Allocated in pool.

Definition at line 439 of file internal.h.

Referenced by build_header_response(), check_write_done(), MHD_request_handle_write_(), and try_ready_chunked_body().

◆ write_buffer_append_offset

size_t MHD_Request::write_buffer_append_offset

Last valid location in write_buffer (where do we append and up to where is it safe to send?)

Definition at line 496 of file internal.h.

Referenced by build_header_response(), check_write_done(), MHD_request_handle_idle_(), MHD_request_handle_write_(), and try_ready_chunked_body().

◆ write_buffer_send_offset

size_t MHD_Request::write_buffer_send_offset

Offset where we are with sending from write_buffer.

Definition at line 490 of file internal.h.

Referenced by build_header_response(), check_write_done(), MHD_request_handle_idle_(), MHD_request_handle_write_(), and try_ready_chunked_body().

◆ write_buffer_size

size_t MHD_Request::write_buffer_size

Size of write_buffer (in bytes).

Definition at line 485 of file internal.h.

Referenced by build_header_response(), check_write_done(), and try_ready_chunked_body().


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