GNU libmicrohttpd  0.9.62
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
MHD_Daemon Struct Reference

#include </opt/rpmbuild/rpmbuild/BUILD/libmicrohttpd-0.9.62/src/lib/internal.h>

Data Fields

MHD_RequestCallback rc
 
void * rc_cls
 
MHD_LoggingCallback logger
 
void * logger_cls
 
MHD_AcceptPolicyCallback accept_policy_cb
 
void * accept_policy_cb_cls
 
MHD_EarlyUriLogCallback early_uri_logger_cb
 
void * early_uri_logger_cb_cls
 
MHD_NotifyConnectionCallback notify_connection_cb
 
void * notify_connection_cb_cls
 
MHD_UnescapeCallback unescape_cb
 
void * unescape_cb_cls
 
struct MHD_Daemonmaster
 
struct MHD_Daemonworker_pool
 
struct MHD_Connectionnormal_timeout_head
 
struct MHD_Connectionnormal_timeout_tail
 
struct MHD_Connectionmanual_timeout_head
 
struct MHD_Connectionmanual_timeout_tail
 
struct MHD_Connectionconnections_head
 
struct MHD_Connectionconnections_tail
 
struct MHD_Connectionsuspended_connections_head
 
struct MHD_Connectionsuspended_connections_tail
 
struct MHD_Connectioncleanup_head
 
struct MHD_Connectioncleanup_tail
 
void * per_ip_connection_count
 
MHD_thread_handle_ID_ pid
 
struct sockaddr_storage listen_sa
 
MHD_mutex_ per_ip_connection_mutex
 
MHD_mutex_ cleanup_connection_mutex
 
size_t listen_sa_len
 
size_t connection_memory_limit_b
 
size_t connection_memory_increment_b
 
size_t thread_stack_limit_b
 
int listen_backlog
 
unsigned int fo_queue_length
 
unsigned int global_connection_limit
 
unsigned int ip_connection_limit
 
unsigned int connections
 
unsigned int worker_pool_size
 
time_t connection_default_timeout
 
MHD_socket listen_socket
 
struct MHD_itc_ itc
 
enum MHD_ThreadingMode threading_mode
 
enum MHD_FastOpenMethod fast_open_method
 
enum MHD_AddressFamily listen_af
 
enum MHD_EventLoopSyscall event_loop_syscall
 
enum MHD_ProtocolStrictLevel protocol_strict_level
 
uint16_t listen_port
 
bool suppress_date
 
bool disable_itc
 
bool disallow_suspend_resume
 
bool disallow_upgrade
 
bool at_limit
 
bool enable_turbo
 
bool data_already_pending
 
bool was_quiesced
 
bool resuming
 
bool allow_address_reuse
 
bool enable_shoutcast
 
volatile bool shutdown
 
MHD_AccessHandlerCallback default_handler
 
void * default_handler_cls
 
MHD_AcceptPolicyCallback apc
 
void * apc_cls
 
MHD_RequestCompletedCallback notify_completed
 
void * notify_completed_cls
 
MHD_NotifyConnectionCallback notify_connection
 
void * notify_connection_cls
 
LogCallback uri_log_callback
 
void * uri_log_callback_cls
 
UnescapeCallback unescape_callback
 
void * unescape_callback_cls
 
size_t pool_size
 
size_t pool_increment
 
MHD_socket listen_fd
 
int listening_address_reuse
 
volatile bool was_quiesced
 
unsigned int connection_limit
 
time_t connection_timeout
 
unsigned int per_ip_connection_limit
 
enum MHD_FLAG options
 
uint16_t port
 
int strict_for_client
 
unsigned int listen_backlog_size
 

Detailed Description

State kept for each MHD daemon. All connections are kept in two doubly-linked lists. The first one reflects the state of the connection in terms of what operations we are waiting for (read, write, locally blocked, cleanup) whereas the second is about its timeout state (default or custom).

Definition at line 997 of file internal.h.

Field Documentation

MHD_AcceptPolicyCallback MHD_Daemon::accept_policy_cb

Function to call to accept/reject connections based on the client's IP address.

Definition at line 1023 of file internal.h.

Referenced by internal_add_connection(), and MHD_daemon_accept_policy().

void* MHD_Daemon::accept_policy_cb_cls

Closure for accept_policy_cb.

Definition at line 1028 of file internal.h.

Referenced by internal_add_connection(), and MHD_daemon_accept_policy().

bool MHD_Daemon::allow_address_reuse

Allow reusing the address:port combination when binding. See MHD_daemon_listen_allow_address_reuse().

Definition at line 1513 of file internal.h.

Referenced by configure_listen_reuse(), and MHD_daemon_listen_allow_address_reuse().

MHD_AcceptPolicyCallback MHD_Daemon::apc

Function to call to check if we should accept or reject an incoming request. May be NULL.

Definition at line 1344 of file internal.h.

Referenced by internal_add_connection(), and MHD_start_daemon_va().

void* MHD_Daemon::apc_cls

Closure argument to apc.

Definition at line 1349 of file internal.h.

Referenced by internal_add_connection(), and MHD_start_daemon_va().

bool MHD_Daemon::at_limit

Did we hit some system or process-wide resource limit while trying to accept() the last time? If so, we don't accept new connections until we close an existing one. This effectively temporarily lowers the "connection_limit" to the current number of connections.

Definition at line 1480 of file internal.h.

Referenced by MHD_accept_connection(), MHD_accept_connection_(), MHD_cleanup_connections(), MHD_connection_cleanup_(), MHD_daemon_select_(), and MHD_select().

struct MHD_Connection * MHD_Daemon::cleanup_head

Head of doubly-linked list of connections to clean up.

Definition at line 1174 of file internal.h.

Referenced by cleanup_connection(), close_connection(), MHD_cleanup_connections(), MHD_connection_cleanup_(), and resume_suspended_connections().

struct MHD_Connection * MHD_Daemon::cleanup_tail

Tail of doubly-linked list of connections to clean up.

Definition at line 1179 of file internal.h.

Referenced by cleanup_connection(), close_connection(), MHD_cleanup_connections(), MHD_connection_cleanup_(), and resume_suspended_connections().

unsigned int MHD_Daemon::connection_limit

Limit on the number of parallel connections.

Definition at line 1560 of file internal.h.

Referenced by internal_add_connection(), MHD_select(), MHD_start_daemon_va(), and parse_options_va().

size_t MHD_Daemon::connection_memory_increment_b

Increment to use when growing the read buffer. Smaller than connection_memory_limit_b.

Definition at line 1293 of file internal.h.

Referenced by MHD_daemon_connection_memory_limit(), MHD_daemon_create(), MHD_request_handle_read_(), and try_grow_read_buffer().

size_t MHD_Daemon::connection_memory_limit_b
time_t MHD_Daemon::connection_timeout

After how many seconds of inactivity should connections time out? Zero for no timeout.

Definition at line 1566 of file internal.h.

Referenced by cleanup_connection(), close_connection(), internal_add_connection(), internal_suspend_connection_(), MHD_set_connection_option(), MHD_start_daemon_va(), MHD_update_last_activity_(), parse_options_va(), and resume_suspended_connections().

struct MHD_Connection * MHD_Daemon::connections_head

Head of doubly-linked list of our current, active connections.

Definition at line 1152 of file internal.h.

Referenced by cleanup_connection(), close_connection(), if(), internal_add_connection(), internal_suspend_connection_(), resume_suspended_connections(), and suspend_action().

bool MHD_Daemon::data_already_pending

'True' if some data is already waiting to be processed. If set to 'true' - zero timeout for select()/poll*() is used. Should be reset each time before processing connections and raised by any connection which require additional immediately processing (application does not provide data for response, data waiting in TLS buffers etc.)

Definition at line 1497 of file internal.h.

Referenced by call_handlers(), internal_run_from_select(), MHD_connection_call_handlers_(), MHD_daemon_get_timeout(), and MHD_get_timeout().

MHD_AccessHandlerCallback MHD_Daemon::default_handler

Callback function for all requests.

Definition at line 1241 of file internal.h.

Referenced by call_connection_handler(), MHD_start_daemon_va(), and process_request_body().

void* MHD_Daemon::default_handler_cls

Closure argument to default_handler.

Definition at line 1246 of file internal.h.

Referenced by call_connection_handler(), MHD_start_daemon_va(), and process_request_body().

bool MHD_Daemon::disable_itc

The use of the inter-thread communication channel is disabled. See MHD_daemon_disable_itc().

Definition at line 1459 of file internal.h.

Referenced by MHD_daemon_disable_itc(), MHD_daemon_quiesce(), MHD_daemon_start(), and setup_thread_pool().

bool MHD_Daemon::disallow_upgrade

Disable #MHD_action_upgrade() functionality. See MHD_daemon_disallow_upgrade().

Definition at line 1471 of file internal.h.

Referenced by MHD_daemon_close_all_connections_(), MHD_daemon_disallow_upgrade(), and response_action().

MHD_EarlyUriLogCallback MHD_Daemon::early_uri_logger_cb

Function to call on the full URL early for logging.

Definition at line 1033 of file internal.h.

Referenced by MHD_daemon_set_early_uri_logger(), and parse_initial_message_line().

void* MHD_Daemon::early_uri_logger_cb_cls

Closure for early_uri_logger_cb.

Definition at line 1038 of file internal.h.

Referenced by MHD_daemon_set_early_uri_logger(), and parse_initial_message_line().

bool MHD_Daemon::enable_shoutcast

MHD should speak SHOUTcast instead of HTTP.

Definition at line 1518 of file internal.h.

Referenced by MHD_daemon_enable_shoutcast().

bool MHD_Daemon::enable_turbo

Disables optional calls to shutdown() and enables aggressive non-blocking optimistic reads and other potentially unsafe optimizations. See MHD_daemon_enable_turbo().

Definition at line 1487 of file internal.h.

Referenced by internal_add_connection(), MHD_connection_mark_closed_(), MHD_daemon_add_connection(), and MHD_daemon_enable_turbo().

enum MHD_EventLoopSyscall MHD_Daemon::event_loop_syscall
enum MHD_FastOpenMethod MHD_Daemon::fast_open_method

When should we use TCP_FASTOPEN? See MHD_daemon_tcp_fastopen().

Definition at line 1420 of file internal.h.

Referenced by MHD_daemon_tcp_fastopen(), and open_listen_socket().

unsigned int MHD_Daemon::fo_queue_length

Queue length to use with fast open.

Definition at line 1343 of file internal.h.

Referenced by MHD_daemon_create(), MHD_daemon_tcp_fastopen(), and open_listen_socket().

unsigned int MHD_Daemon::global_connection_limit

Maximum number of connections MHD accepts. 0 for unlimited.

Definition at line 1348 of file internal.h.

Referenced by internal_add_connection(), MHD_daemon_connection_limits(), MHD_daemon_select_(), and setup_thread_pool().

unsigned int MHD_Daemon::ip_connection_limit

Maximum number of connections we accept per IP, 0 for unlimited.

Definition at line 1353 of file internal.h.

Referenced by MHD_daemon_connection_limits(), MHD_ip_limit_add(), and MHD_ip_limit_del().

enum MHD_AddressFamily MHD_Daemon::listen_af

Address family to use when listening. Default is #MHD_AF_NONE (do not listen).

Definition at line 1426 of file internal.h.

Referenced by MHD_daemon_bind_port(), and open_listen_socket().

int MHD_Daemon::listen_backlog

Backlog argument to use for listen. See MHD_daemon_listen_backlog().

Definition at line 1333 of file internal.h.

Referenced by MHD_daemon_create(), MHD_daemon_listen_backlog(), and open_listen_socket().

unsigned int MHD_Daemon::listen_backlog_size

The size of queue for listen socket.

Definition at line 1723 of file internal.h.

Referenced by MHD_start_daemon_va(), and parse_options_va().

uint16_t MHD_Daemon::listen_port

On which port should we listen on? Only effective if we were not given a listen socket or a full address via #MHD_daemon_bind_sa(). 0 means to bind to random free port.

Definition at line 1446 of file internal.h.

Referenced by get_listen_port_number(), MHD_daemon_bind_port(), MHD_daemon_get_information_sz(), and open_listen_socket().

struct sockaddr_storage MHD_Daemon::listen_sa

Socket address to bind to for the listen socket.

Definition at line 1251 of file internal.h.

Referenced by MHD_daemon_bind_socket_address(), and open_listen_socket().

size_t MHD_Daemon::listen_sa_len

Number of (valid) bytes in listen_sa. Zero if listen_sa is not initialized.

Definition at line 1268 of file internal.h.

Referenced by MHD_daemon_bind_socket_address(), and open_listen_socket().

int MHD_Daemon::listening_address_reuse

Whether to allow/disallow/ignore reuse of listening address. The semantics is the following: 0: ignore (user did not ask for neither allow/disallow, use SO_REUSEADDR except W32) >0: allow (use SO_REUSEPORT on most platforms, SO_REUSEADDR on Windows) <0: disallow (mostly no action, SO_EXCLUSIVEADDRUSE on Windows or SO_EXCLBIND on Solaris)

Definition at line 1479 of file internal.h.

Referenced by MHD_start_daemon_va(), and parse_options_va().

MHD_LoggingCallback MHD_Daemon::logger

Function to call for logging.

Definition at line 1012 of file internal.h.

Referenced by MHD_daemon_create(), and MHD_daemon_set_logger().

void* MHD_Daemon::logger_cls

Closure for logger.

Definition at line 1017 of file internal.h.

Referenced by MHD_daemon_create(), and MHD_daemon_set_logger().

struct MHD_Connection * MHD_Daemon::manual_timeout_head

Head of the XDLL of ALL connections with a non-default/custom timeout, unsorted. MHD will do a O(n) scan over this list to determine the current timeout. Not used in MHD_USE_THREAD_PER_CONNECTION mode.

Definition at line 1140 of file internal.h.

Referenced by cleanup_connection(), close_connection(), if(), internal_suspend_connection_(), MHD_connection_set_timeout(), MHD_set_connection_option(), resume_suspended_connections(), and suspend_action().

struct MHD_Connection * MHD_Daemon::manual_timeout_tail

Tail of the XDLL of ALL connections with a non-default/custom timeout, unsorted. Not used in MHD_USE_THREAD_PER_CONNECTION mode.

Definition at line 1147 of file internal.h.

Referenced by cleanup_connection(), close_connection(), if(), internal_suspend_connection_(), MHD_connection_set_timeout(), MHD_daemon_get_timeout(), MHD_get_timeout(), MHD_set_connection_option(), resume_suspended_connections(), and suspend_action().

struct MHD_Daemon * MHD_Daemon::master

Pointer to master daemon (NULL if this is the master)

Definition at line 1065 of file internal.h.

Referenced by get_master(), MHD_daemon_destroy(), MHD_get_master(), MHD_start_daemon_va(), MHD_stop_daemon(), and setup_thread_pool().

struct MHD_Connection * MHD_Daemon::normal_timeout_head

Head of the XDLL of ALL connections with a default ('normal') timeout, sorted by timeout (earliest at the tail, most recently used connection at the head). MHD can just look at the tail of this list to determine the timeout for all of its elements; whenever there is an event of a connection, the connection is moved back to the tail of the list.

All connections by default start in this list; if a custom timeout that does not match connection_timeout is set, they are moved to the manual_timeout_head-XDLL. Not used in MHD_USE_THREAD_PER_CONNECTION mode as each thread needs only one connection-specific timeout.

Definition at line 1125 of file internal.h.

Referenced by cleanup_connection(), close_connection(), if(), internal_add_connection(), internal_suspend_connection_(), MHD_connection_set_timeout(), MHD_connection_update_last_activity_(), MHD_set_connection_option(), MHD_update_last_activity_(), resume_suspended_connections(), and suspend_action().

struct MHD_Connection * MHD_Daemon::normal_timeout_tail

Tail of the XDLL of ALL connections with a default timeout, sorted by timeout (earliest timeout at the tail). Not used in MHD_USE_THREAD_PER_CONNECTION mode.

Definition at line 1132 of file internal.h.

Referenced by cleanup_connection(), close_connection(), if(), internal_add_connection(), internal_suspend_connection_(), MHD_connection_set_timeout(), MHD_connection_update_last_activity_(), MHD_daemon_get_timeout(), MHD_get_timeout(), MHD_set_connection_option(), MHD_update_last_activity_(), resume_suspended_connections(), and suspend_action().

MHD_RequestCompletedCallback MHD_Daemon::notify_completed

Function to call when we are done processing a particular request. May be NULL.

Definition at line 1355 of file internal.h.

Referenced by MHD_connection_close_(), MHD_connection_handle_idle(), MHD_start_daemon_va(), parse_options_va(), and resume_suspended_connections().

void* MHD_Daemon::notify_completed_cls

Closure argument to notify_completed.

Definition at line 1360 of file internal.h.

Referenced by MHD_connection_close_(), MHD_connection_handle_idle(), parse_options_va(), and resume_suspended_connections().

MHD_NotifyConnectionCallback MHD_Daemon::notify_connection

Function to call when we are starting/stopping a connection. May be NULL.

Definition at line 1366 of file internal.h.

Referenced by internal_add_connection(), MHD_cleanup_connections(), and parse_options_va().

MHD_NotifyConnectionCallback MHD_Daemon::notify_connection_cb

Function to call whenever a connection is started or closed.

Definition at line 1044 of file internal.h.

Referenced by internal_add_connection(), MHD_connection_cleanup_(), MHD_connection_close_(), and MHD_daemon_set_notify_connection().

void* MHD_Daemon::notify_connection_cb_cls

Closure for notify_connection_cb.

Definition at line 1049 of file internal.h.

Referenced by internal_add_connection(), MHD_connection_cleanup_(), MHD_connection_close_(), and MHD_daemon_set_notify_connection().

void* MHD_Daemon::notify_connection_cls

Closure argument to notify_connection.

Definition at line 1371 of file internal.h.

Referenced by internal_add_connection(), MHD_cleanup_connections(), and parse_options_va().

void * MHD_Daemon::per_ip_connection_count

Table storing number of connections per IP

Definition at line 1184 of file internal.h.

Referenced by MHD_ip_limit_add(), and MHD_ip_limit_del().

unsigned int MHD_Daemon::per_ip_connection_limit

Maximum number of connections per IP, or 0 for unlimited.

Definition at line 1572 of file internal.h.

Referenced by MHD_ip_limit_add(), MHD_ip_limit_del(), and parse_options_va().

MHD_mutex_ MHD_Daemon::per_ip_connection_mutex

Mutex for per-IP connection counts.

Definition at line 1256 of file internal.h.

Referenced by MHD_daemon_create(), MHD_daemon_destroy(), MHD_ip_count_lock(), MHD_ip_count_unlock(), MHD_start_daemon_va(), and MHD_stop_daemon().

MHD_thread_handle_ID_ MHD_Daemon::pid

The select thread handle (if we have internal select)

Definition at line 1246 of file internal.h.

Referenced by internal_add_connection(), MHD_daemon_destroy(), MHD_daemon_start(), MHD_polling_thread(), MHD_start_daemon_va(), MHD_stop_daemon(), and setup_thread_pool().

size_t MHD_Daemon::pool_increment

Increment for growth of the per-connection memory pools.

Definition at line 1435 of file internal.h.

Referenced by MHD_connection_handle_read(), MHD_start_daemon_va(), and parse_options_va().

size_t MHD_Daemon::pool_size

Size of the per-connection memory pools.

Definition at line 1430 of file internal.h.

Referenced by internal_add_connection(), MHD_connection_handle_idle(), MHD_start_daemon_va(), parse_options_va(), try_grow_read_buffer(), and try_ready_chunked_body().

uint16_t MHD_Daemon::port

Listen port.

Definition at line 1582 of file internal.h.

Referenced by MHD_get_daemon_info(), and MHD_start_daemon_va().

enum MHD_ProtocolStrictLevel MHD_Daemon::protocol_strict_level

How strictly do we enforce the HTTP protocol? See MHD_daemon_protocol_strict_level().

Definition at line 1439 of file internal.h.

Referenced by MHD_daemon_protocol_strict_level(), parse_initial_message_line(), parse_request_headers(), and process_header_line().

MHD_RequestCallback MHD_Daemon::rc

Function to call to handle incoming requests.

Definition at line 1002 of file internal.h.

Referenced by call_request_handler(), MHD_daemon_create(), and process_request_body().

void* MHD_Daemon::rc_cls

Closure for rc.

Definition at line 1007 of file internal.h.

Referenced by call_request_handler(), MHD_daemon_create(), and process_request_body().

bool MHD_Daemon::resuming

Is some connection wanting to resume?

Definition at line 1507 of file internal.h.

Referenced by close_all_connections(), MHD_daemon_close_all_connections_(), MHD_request_resume(), MHD_resume_connection(), and resume_suspended_connections().

int MHD_Daemon::strict_for_client

Be neutral (zero), strict (1) or permissive (-1) to client.

Definition at line 1587 of file internal.h.

Referenced by MHD_start_daemon_va(), parse_connection_headers(), parse_initial_message_line(), parse_options_va(), and process_header_line().

bool MHD_Daemon::suppress_date

Suppress generating the "Date:" header, this system lacks an RTC (or developer is hyper-optimizing). See MHD_daemon_suppress_date_no_clock().

Definition at line 1453 of file internal.h.

Referenced by build_header_response(), and MHD_daemon_suppress_date_no_clock().

struct MHD_Connection * MHD_Daemon::suspended_connections_head

Head of doubly-linked list of our current but suspended connections.

Definition at line 1163 of file internal.h.

Referenced by cleanup_connection(), close_all_connections(), internal_suspend_connection_(), MHD_daemon_close_all_connections_(), resume_suspended_connections(), and suspend_action().

struct MHD_Connection * MHD_Daemon::suspended_connections_tail

Tail of doubly-linked list of our current but suspended connections.

Definition at line 1169 of file internal.h.

Referenced by cleanup_connection(), close_all_connections(), if(), internal_suspend_connection_(), MHD_daemon_close_all_connections_(), resume_suspended_connections(), and suspend_action().

size_t MHD_Daemon::thread_stack_limit_b

Desired size of the stack for threads created by MHD, 0 for system default.

Definition at line 1299 of file internal.h.

Referenced by internal_add_connection(), MHD_daemon_start(), MHD_daemon_thread_stack_size(), and setup_thread_pool().

UnescapeCallback MHD_Daemon::unescape_callback

Function to call when we unescape escape sequences.

Definition at line 1390 of file internal.h.

Referenced by digest_auth_check_all(), MHD_parse_arguments_(), MHD_start_daemon_va(), parse_initial_message_line(), and parse_options_va().

void* MHD_Daemon::unescape_callback_cls

Closure for unescape_callback.

Definition at line 1395 of file internal.h.

Referenced by digest_auth_check_all(), MHD_parse_arguments_(), parse_initial_message_line(), and parse_options_va().

MHD_UnescapeCallback MHD_Daemon::unescape_cb

Function to call to unescape sequences in URIs and URI arguments. See MHD_daemon_unescape_cb().

Definition at line 1055 of file internal.h.

Referenced by MHD_daemon_create(), MHD_daemon_unescape_cb(), MHD_parse_arguments_(), and parse_initial_message_line().

void* MHD_Daemon::unescape_cb_cls

Closure for unescape_cb.

Definition at line 1060 of file internal.h.

Referenced by MHD_daemon_unescape_cb(), MHD_parse_arguments_(), and parse_initial_message_line().

LogCallback MHD_Daemon::uri_log_callback

Function to call with the full URI at the beginning of request processing. May be NULL.

Returns the initial pointer to internal state kept by the client for the request.

Definition at line 1380 of file internal.h.

Referenced by parse_initial_message_line(), and parse_options_va().

void* MHD_Daemon::uri_log_callback_cls

Closure argument to uri_log_callback.

Definition at line 1385 of file internal.h.

Referenced by parse_initial_message_line(), and parse_options_va().

volatile bool MHD_Daemon::was_quiesced

Has this deamon been quiesced via MHD_quiesce_daemon()? If so, we should no longer use the listen_fd (including removing it from the epoll_fd when possible).

Definition at line 1525 of file internal.h.


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