MHD_Connection Struct Reference

#include <internal.h>

Data Fields

struct MHD_Connectionnext
struct MHD_Daemondaemon
struct MHD_HTTP_Headerheaders_received
struct MHD_Responseresponse
struct MemoryPool * pool
void * client_context
char * method
char * url
char * version
char * read_buffer
char * write_buffer
char * last
char * colon
struct sockaddr_in * addr
pthread_t pid
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
uint64_t remaining_upload_size
uint64_t response_write_position
size_t continue_message_write_offset
socklen_t addr_len
time_t last_activity
int client_aware
int socket_fd
int read_closed
enum MHD_CONNECTION_STATE state
unsigned int responseCode
int response_unready
int have_chunked_response
int have_chunked_upload
unsigned int current_chunk_size
unsigned int current_chunk_offset
int(* read_handler )(struct MHD_Connection *connection)
int(* write_handler )(struct MHD_Connection *connection)
int(* idle_handler )(struct MHD_Connection *connection)
ReceiveCallback recv_cls
TransmitCallback send_cls

Detailed Description

State kept for each HTTP request.

Definition at line 428 of file internal.h.


Field Documentation

struct sockaddr_in* MHD_Connection::addr [read]

Foreign address (of length addr_len). MALLOCED (not in pool!).

Definition at line 522 of file internal.h.

Referenced by MHD_accept_connection(), MHD_cleanup_connections(), and MHD_get_connection_info().

Length of the foreign address.

Definition at line 582 of file internal.h.

Referenced by MHD_accept_connection(), and MHD_cleanup_connections().

Did we ever call the "default_handler" on this connection? (this flag will determine if we call the 'notify_completed' handler when the connection closes down).

Definition at line 595 of file internal.h.

Referenced by call_connection_handler(), MHD_connection_close(), MHD_connection_handle_idle(), and process_request_body().

We allow the main application to associate some pointer with the connection. Here is where we store it. (MHD does not know or care what it is).

Definition at line 469 of file internal.h.

Referenced by call_connection_handler(), MHD_connection_close(), MHD_connection_handle_idle(), parse_initial_message_line(), and process_request_body().

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

Definition at line 516 of file internal.h.

Referenced by process_broken_line(), and process_header_line().

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

Definition at line 577 of file internal.h.

Referenced by MHD_connection_handle_idle(), MHD_connection_handle_write(), and need_100_continue().

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

Definition at line 659 of file internal.h.

Referenced by process_request_body().

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 653 of file internal.h.

Referenced by process_request_body().

Are we sending with chunked encoding?

Definition at line 636 of file internal.h.

Referenced by MHD_queue_response().

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).

Definition at line 645 of file internal.h.

Referenced by add_extra_headers(), MHD_connection_handle_idle(), parse_connection_headers(), and process_request_body().

int(* MHD_Connection::idle_handler)(struct MHD_Connection *connection)

Handler used for processing idle connection operations

Referenced by MHD_handle_connection(), MHD_select(), MHD_set_http_callbacks_(), and MHD_set_https_callbacks().

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

Definition at line 508 of file internal.h.

Referenced by process_broken_line(), and process_header_line().

This is a linked list.

Definition at line 434 of file internal.h.

Referenced by MHD_accept_connection(), MHD_cleanup_connections(), MHD_get_fdset(), MHD_get_timeout(), and MHD_select().

Thread for this connection (if we are using one thread per connection).

Definition at line 528 of file internal.h.

Referenced by MHD_accept_connection(), and MHD_cleanup_connections().

struct MemoryPool* MHD_Connection::pool [read]

The memory pool is created whenever we first read from the TCP stream and destroyed at the end of each request (and re-created for the next request). In the meantime, this pointer is NULL. The pool is used for all connection-related data except for the response (which maybe shared between connections) and the IP address (which persists across individual requests).

Definition at line 461 of file internal.h.

Referenced by build_header_response(), check_write_done(), connection_add_header(), get_next_header_line(), MHD_accept_connection(), MHD_cleanup_connections(), MHD_connection_get_pollfd(), MHD_connection_handle_idle(), MHD_connection_handle_read(), MHD_set_connection_value(), parse_cookie_header(), process_broken_line(), try_grow_read_buffer(), and try_ready_chunked_body().

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 495 of file internal.h.

Referenced by do_read(), get_next_header_line(), MHD_connection_handle_idle(), MHD_connection_handle_read(), process_request_body(), and try_grow_read_buffer().

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

Definition at line 542 of file internal.h.

Referenced by do_read(), get_next_header_line(), MHD_connection_get_pollfd(), MHD_connection_handle_idle(), MHD_connection_handle_read(), and process_request_body().

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 536 of file internal.h.

Referenced by do_read(), get_next_header_line(), MHD_connection_get_pollfd(), MHD_connection_handle_idle(), MHD_connection_handle_read(), and try_grow_read_buffer().

Has this socket been closed for reading (i.e. other side closed the connection)? If so, we must completely close the connection once we are done sending our response (and stop trying to read from this socket).

Definition at line 611 of file internal.h.

Referenced by do_read(), MHD_connection_get_pollfd(), MHD_connection_handle_idle(), MHD_connection_handle_read(), MHD_queue_response(), parse_connection_headers(), and transmit_error_response().

int(* MHD_Connection::read_handler)(struct MHD_Connection *connection)

Handler used for processing read connection operations

Referenced by MHD_handle_connection(), MHD_select(), MHD_set_http_callbacks_(), and MHD_set_https_callbacks().

Function used for reading HTTP request stream.

Definition at line 679 of file internal.h.

Referenced by do_read(), and MHD_accept_connection().

How many more bytes of the body do we expect to read? "-1" for unknown.

Definition at line 564 of file internal.h.

Referenced by MHD_connection_handle_idle(), parse_connection_headers(), and process_request_body().

Set to MHD_YES if the response's content reader callback failed to provide data the last time we tried to read from it. In that case, the write socket should be marked as unready until the CRC call succeeds.

Definition at line 631 of file internal.h.

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

Definition at line 571 of file internal.h.

Referenced by MHD_connection_handle_idle(), MHD_connection_handle_write(), MHD_queue_response(), send_param_adapter(), try_ready_chunked_body(), and try_ready_normal_body().

HTTP response code. Only valid if response object is already set.

Definition at line 622 of file internal.h.

Referenced by build_header_response(), MHD_connection_handle_idle(), and MHD_queue_response().

Function used for writing HTTP response stream.

Definition at line 684 of file internal.h.

Referenced by do_write(), MHD_accept_connection(), and MHD_connection_handle_write().

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

Definition at line 501 of file internal.h.

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

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

Definition at line 558 of file internal.h.

Referenced by build_header_response(), check_write_done(), do_write(), MHD_connection_handle_idle(), send_param_adapter(), and try_ready_chunked_body().

Offset where we are with sending from write_buffer.

Definition at line 552 of file internal.h.

Referenced by build_header_response(), check_write_done(), do_write(), MHD_connection_handle_idle(), send_param_adapter(), and try_ready_chunked_body().

Size of write_buffer (in bytes).

Definition at line 547 of file internal.h.

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

int(* MHD_Connection::write_handler)(struct MHD_Connection *connection)

Handler used for processing write connection operations

Referenced by MHD_handle_connection(), MHD_select(), MHD_set_http_callbacks_(), and MHD_set_https_callbacks().


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

Generated on 16 Nov 2010 for GNU libmicrohttpd by  doxygen 1.6.1