GNU libmicrohttpd  0.9.29
misc. specialized functions

Macros

#define MHD_ICY_FLAG   ((uint32_t)(((uint32_t)1) << 31))
 

Functions

_MHD_EXTERN MHD_socket MHD_quiesce_daemon (struct MHD_Daemon *daemon)
 
_MHD_EXTERN int MHD_add_connection (struct MHD_Daemon *daemon, MHD_socket client_socket, const struct sockaddr *addr, socklen_t addrlen)
 
const union MHD_ConnectionInfoMHD_get_connection_info (struct MHD_Connection *connection, enum MHD_ConnectionInfoType info_type,...)
 
int MHD_set_connection_option (struct MHD_Connection *connection, enum MHD_CONNECTION_OPTION option,...)
 
const union MHD_DaemonInfo * MHD_get_daemon_info (struct MHD_Daemon *daemon, enum MHD_DaemonInfoType info_type,...)
 
const char * MHD_get_version (void)
 
_MHD_EXTERN int MHD_is_feature_supported (enum MHD_FEATURE feature)
 

Detailed Description

This group includes functions that do not fit into any particular category and that are rarely used.

Macro Definition Documentation

◆ MHD_ICY_FLAG

#define MHD_ICY_FLAG   ((uint32_t)(((uint32_t)1) << 31))

Flag to be or-ed with MHD_HTTP status code for SHOUTcast. This will cause the response to begin with the SHOUTcast "ICY" line instad of "HTTP".

Definition at line 408 of file microhttpd.h.

Referenced by build_header_response().

Function Documentation

◆ MHD_add_connection()

int MHD_add_connection ( struct MHD_Daemon daemon,
MHD_socket  client_socket,
const struct sockaddr *  addr,
socklen_t  addrlen 
)

Add another client connection to the set of connections managed by MHD. This API is usually not needed (since MHD will accept inbound connections on the server socket). Use this API in special cases, for example if your HTTP server is behind NAT and needs to connect out to the HTTP client, or if you are building a proxy.

If you use this API in conjunction with a internal select or a thread pool, you must set the option MHD_USE_ITC to ensure that the freshly added connection is immediately processed by MHD.

The given client socket will be managed (and closed!) by MHD after this call and must no longer be used directly by the application afterwards.

Per-IP connection limits are ignored when using this API.

Parameters
daemondaemon that manages the connection
client_socketsocket to manage (MHD will expect to receive an HTTP request from this socket next).
addrIP address of the client
addrlennumber of bytes in addr
Returns
MHD_YES on success, MHD_NO if this daemon could not handle the connection (i.e. malloc() failed, etc). The socket will be closed in any case; errno is set to indicate further details about the error.

Add another client connection to the set of connections managed by MHD. This API is usually not needed (since MHD will accept inbound connections on the server socket). Use this API in special cases, for example if your HTTP server is behind NAT and needs to connect out to the HTTP client, or if you are building a proxy.

If you use this API in conjunction with a internal select or a thread pool, you must set the option MHD_USE_ITC to ensure that the freshly added connection is immediately processed by MHD.

The given client socket will be managed (and closed!) by MHD after this call and must no longer be used directly by the application afterwards.

Per-IP connection limits are ignored when using this API.

Parameters
daemondaemon that manages the connection
client_socketsocket to manage (MHD will expect to receive an HTTP request from this socket next).
addrIP address of the client
addrlennumber of bytes in addr
Returns
MHD_YES on success, MHD_NO if this daemon could not handle the connection (i.e. malloc() failed, etc). The socket will be closed in any case; errno is set to indicate further details about the error.

Definition at line 2996 of file daemon.c.

References _, internal_add_connection(), MHD_socket_last_strerr_, MHD_socket_nonblocking_(), MHD_socket_noninheritable_(), MHD_USE_TURBO, MHD_YES, and MHD_Daemon::options.

Here is the call graph for this function:

◆ MHD_get_connection_info()

◆ MHD_get_daemon_info()

const union MHD_DaemonInfo* MHD_get_daemon_info ( struct MHD_Daemon daemon,
enum MHD_DaemonInfoType  info_type,
  ... 
)

Obtain information about the given daemon (not fully implemented!).

Parameters
daemonwhat daemon to get information about
info_typewhat information is desired?
...depends on info_type
Returns
NULL if this information is not available (or if the info_type is unknown)

Definition at line 6459 of file daemon.c.

References MHD_Daemon::connections, MHD_Daemon::listen_fd, MHD_cleanup_connections(), MHD_DAEMON_INFO_CURRENT_CONNECTIONS, MHD_DAEMON_INFO_EPOLL_FD, MHD_DAEMON_INFO_FLAGS, MHD_DAEMON_INFO_KEY_SIZE, MHD_DAEMON_INFO_LISTEN_FD, MHD_DAEMON_INFO_MAC_KEY_SIZE, MHD_USE_INTERNAL_POLLING_THREAD, NULL, MHD_Daemon::options, MHD_Daemon::worker_pool, and MHD_Daemon::worker_pool_size.

Here is the call graph for this function:

◆ MHD_get_version()

const char* MHD_get_version ( void  )

Obtain the version of this library

Returns
static version string, e.g. "0.9.9"

Definition at line 6536 of file daemon.c.

References _MHD_EXTERN, and MHD_VERSION.

◆ MHD_is_feature_supported()

_MHD_EXTERN int MHD_is_feature_supported ( enum MHD_FEATURE  feature)

Get information about supported MHD features. Indicate that MHD was compiled with or without support for particular feature. Some features require additional support by kernel. Kernel support is not checked by this function.

Parameters
featuretype of requested information
Returns
MHD_YES if feature is supported by MHD, MHD_NO if feature is not supported or feature is unknown.

Definition at line 6570 of file daemon.c.

References MHD_NO, MHD_YES, and NULL.

◆ MHD_quiesce_daemon()

MHD_socket MHD_quiesce_daemon ( struct MHD_Daemon daemon)

Stop accepting connections from the listening socket. Allows clients to continue processing, but stops accepting new connections. Note that the caller is responsible for closing the returned socket; however, if MHD is run using threads (anything but external select mode), it must not be closed until AFTER MHD_stop_daemon has been called (as it is theoretically possible that an existing thread is still using it).

Note that some thread modes require the caller to have passed MHD_USE_ITC when using this API. If this daemon is in one of those modes and this option was not given to MHD_start_daemon, this function will return MHD_INVALID_SOCKET.

Parameters
daemondaemon to stop accepting new connections for
Returns
old listen socket on success, MHD_INVALID_SOCKET if the daemon was already not listening anymore

Stop accepting connections from the listening socket. Allows clients to continue processing, but stops accepting new connections. Note that the caller is responsible for closing the returned socket; however, if MHD is run using threads (anything but external select mode), socket will be removed from existing threads with some delay and it must not be closed while it's in use. To make sure that the socket is not used anymore, call MHD_stop_daemon.

Note that some thread modes require the caller to have passed MHD_USE_ITC when using this API. If this daemon is in one of those modes and this option was not given to MHD_start_daemon, this function will return MHD_INVALID_SOCKET.

Parameters
daemondaemon to stop accepting new connections for
Returns
old listen socket on success, MHD_INVALID_SOCKET if the daemon was already not listening anymore

Definition at line 4667 of file daemon.c.

References _, MHD_Daemon::itc, MHD_Daemon::listen_fd, MHD_INVALID_SOCKET, MHD_PANIC, MHD_USE_EPOLL, MHD_USE_INTERNAL_POLLING_THREAD, MHD_USE_ITC, NULL, MHD_Daemon::options, MHD_Daemon::was_quiesced, MHD_Daemon::worker_pool, and MHD_Daemon::worker_pool_size.

◆ MHD_set_connection_option()

int MHD_set_connection_option ( struct MHD_Connection connection,
enum MHD_CONNECTION_OPTION  option,
  ... 
)

Set a custom option for the given connection, overriding defaults.

Parameters
connectionconnection to modify
optionoption to set
...arguments to the option, depending on the option type
Returns
MHD_YES on success, MHD_NO if setting the option failed

Definition at line 3516 of file connection.c.

References MHD_Daemon::cleanup_connection_mutex, MHD_Connection::connection_timeout, MHD_Daemon::connection_timeout, MHD_Connection::daemon, MHD_Connection::last_activity, MHD_Daemon::manual_timeout_head, MHD_Daemon::manual_timeout_tail, MHD_monotonic_sec_counter(), MHD_mutex_lock_chk_, MHD_mutex_unlock_chk_, MHD_NO, MHD_USE_THREAD_PER_CONNECTION, MHD_YES, MHD_Daemon::normal_timeout_head, MHD_Daemon::normal_timeout_tail, MHD_Daemon::options, MHD_Connection::suspended, XDLL_insert, and XDLL_remove.

Here is the call graph for this function: