GNU libmicrohttpd  0.9.5
internal.h File Reference

internal shared structures More...

#include "platform.h"
#include "microhttpd.h"
Include dependency graph for internal.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  MHD_Pollfd
struct  MHD_NonceNc
struct  MHD_HTTP_Header
struct  MHD_Response
struct  MHD_Connection
struct  MHD_Daemon

Macros

#define EXTRA_CHECKS   MHD_NO
#define MHD_MAX(a, b)   ((a)<(b)) ? (b) : (a)
#define MHD_MIN(a, b)   ((a)<(b)) ? (a) : (b)
#define MHD_BUF_INC_SIZE   2048
#define MHD_PANIC(msg)   mhd_panic (mhd_panic_cls, __FILE__, __LINE__, NULL)
#define MAX_NONCE_LENGTH   129
#define DEBUG_STATES   MHD_NO
#define EXTRA_CHECK(a)
#define DLL_insert(head, tail, element)
#define DLL_remove(head, tail, element)

Typedefs

typedef ssize_t(* ReceiveCallback )(struct MHD_Connection *conn, void *write_to, size_t max_bytes)
typedef ssize_t(* TransmitCallback )(struct MHD_Connection *conn, const void *write_to, size_t max_bytes)
typedef void *(* LogCallback )(void *cls, const char *uri)
typedef size_t(* UnescapeCallback )(void *cls, struct MHD_Connection *conn, char *uri)

Enumerations

enum  MHD_PollActions { MHD_POLL_ACTION_NOTHING = 0, MHD_POLL_ACTION_IN = 1, MHD_POLL_ACTION_OUT = 2 }
enum  MHD_CONNECTION_STATE {
  MHD_CONNECTION_INIT = 0, MHD_CONNECTION_URL_RECEIVED = MHD_CONNECTION_INIT + 1, MHD_CONNECTION_HEADER_PART_RECEIVED = MHD_CONNECTION_URL_RECEIVED + 1, MHD_CONNECTION_HEADERS_RECEIVED = MHD_CONNECTION_HEADER_PART_RECEIVED + 1,
  MHD_CONNECTION_HEADERS_PROCESSED = MHD_CONNECTION_HEADERS_RECEIVED + 1, MHD_CONNECTION_CONTINUE_SENDING = MHD_CONNECTION_HEADERS_PROCESSED + 1, MHD_CONNECTION_CONTINUE_SENT = MHD_CONNECTION_CONTINUE_SENDING + 1, MHD_CONNECTION_BODY_RECEIVED = MHD_CONNECTION_CONTINUE_SENT + 1,
  MHD_CONNECTION_FOOTER_PART_RECEIVED = MHD_CONNECTION_BODY_RECEIVED + 1, MHD_CONNECTION_FOOTERS_RECEIVED = MHD_CONNECTION_FOOTER_PART_RECEIVED + 1, MHD_CONNECTION_HEADERS_SENDING = MHD_CONNECTION_FOOTERS_RECEIVED + 1, MHD_CONNECTION_HEADERS_SENT = MHD_CONNECTION_HEADERS_SENDING + 1,
  MHD_CONNECTION_NORMAL_BODY_READY = MHD_CONNECTION_HEADERS_SENT + 1, MHD_CONNECTION_NORMAL_BODY_UNREADY = MHD_CONNECTION_NORMAL_BODY_READY + 1, MHD_CONNECTION_CHUNKED_BODY_READY = MHD_CONNECTION_NORMAL_BODY_UNREADY + 1, MHD_CONNECTION_CHUNKED_BODY_UNREADY = MHD_CONNECTION_CHUNKED_BODY_READY + 1,
  MHD_CONNECTION_BODY_SENT = MHD_CONNECTION_CHUNKED_BODY_UNREADY + 1, MHD_CONNECTION_FOOTERS_SENDING = MHD_CONNECTION_BODY_SENT + 1, MHD_CONNECTION_FOOTERS_SENT = MHD_CONNECTION_FOOTERS_SENDING + 1, MHD_CONNECTION_CLOSED = MHD_CONNECTION_FOOTERS_SENT + 1,
  MHD_CONNECTION_IN_CLEANUP = MHD_CONNECTION_CLOSED + 1, MHD_TLS_CONNECTION_INIT = MHD_CONNECTION_CLOSED + 1
}

Functions

size_t MHD_http_unescape (void *cls, struct MHD_Connection *connection, char *val)
time_t MHD_monotonic_time (void)

Variables

MHD_PanicCallback mhd_panic
void * mhd_panic_cls

Detailed Description

internal shared structures

Author
Daniel Pittman
Christian Grothoff

Definition in file internal.h.

Macro Definition Documentation

#define DEBUG_STATES   MHD_NO

Should all state transitions be printed to stderr?

Definition at line 426 of file internal.h.

#define DLL_insert (   head,
  tail,
  element 
)
Value:
do { \
(element)->next = (head); \
(element)->prev = NULL; \
if ((tail) == NULL) \
(tail) = element; \
else \
(head)->prev = element; \
(head) = (element); } while (0)

Insert an element at the head of a DLL. Assumes that head, tail and element are structs with prev and next fields.

Parameters
headpointer to the head of the DLL
tailpointer to the tail of the DLL
elementelement to insert

Definition at line 1050 of file internal.h.

Referenced by close_all_connections(), MHD_add_connection(), and MHD_connection_handle_idle().

#define DLL_remove (   head,
  tail,
  element 
)
Value:
do { \
if ((element)->prev == NULL) \
(head) = (element)->next; \
else \
(element)->prev->next = (element)->next; \
if ((element)->next == NULL) \
(tail) = (element)->prev; \
else \
(element)->next->prev = (element)->prev; \
(element)->next = NULL; \
(element)->prev = NULL; } while (0)

Remove an element from a DLL. Assumes that head, tail and element are structs with prev and next fields.

Parameters
headpointer to the head of the DLL
tailpointer to the tail of the DLL
elementelement to remove

Definition at line 1069 of file internal.h.

Referenced by close_all_connections(), MHD_add_connection(), MHD_cleanup_connections(), and MHD_connection_handle_idle().

#define EXTRA_CHECKS   MHD_NO

Should we perform additional sanity checks at runtime (on our internal invariants)? This may lead to aborts, but can be useful for debugging.

Definition at line 40 of file internal.h.

#define MAX_NONCE_LENGTH   129

Maximum length of a nonce in digest authentication. 32(MD5 Hex) + 8(Timestamp Hex) + 1(NULL); hence 41 should suffice, but Opera (already) takes more (see Mantis #1633), so we've increased the value to support something longer...

Definition at line 125 of file internal.h.

Referenced by MHD_digest_auth_check().

#define MHD_BUF_INC_SIZE   2048

Size by which MHD usually tries to increment read/write buffers. TODO: we should probably get rid of this magic constant and put in code to automatically determine a good value.

Definition at line 51 of file internal.h.

Referenced by get_next_header_line(), MHD_connection_handle_read(), and try_grow_read_buffer().

#define MHD_MAX (   a,
 
)    ((a)<(b)) ? (b) : (a)

Definition at line 42 of file internal.h.

#define MHD_MIN (   a,
 
)    ((a)<(b)) ? (a) : (b)

Definition at line 43 of file internal.h.

Referenced by try_ready_normal_body().

#define MHD_PANIC (   msg)    mhd_panic (mhd_panic_cls, __FILE__, __LINE__, NULL)

Trigger 'panic' action based on fatal errors.

Parameters
errormessage (const char *)

Definition at line 76 of file internal.h.

Referenced by close_all_connections(), MHD_add_connection(), MHD_cleanup_connections(), MHD_connection_handle_idle(), MHD_ip_count_lock(), MHD_ip_count_unlock(), MHD_ip_limit_del(), and MHD_stop_daemon().

Typedef Documentation

typedef void*(* LogCallback)(void *cls, const char *uri)

Signature of function called to log URI accesses.

Parameters
clsclosure
uriuri being accessed
Returns
new closure

Definition at line 763 of file internal.h.

typedef ssize_t(* ReceiveCallback)(struct MHD_Connection *conn, void *write_to, size_t max_bytes)

Function to receive plaintext data.

Parameters
connthe connection struct
write_towhere to write received data
max_bytesmaximum number of bytes to receive
Returns
number of bytes written to write_to

Definition at line 444 of file internal.h.

typedef ssize_t(* TransmitCallback)(struct MHD_Connection *conn, const void *write_to, size_t max_bytes)

Function to transmit plaintext data.

Parameters
connthe connection struct
read_fromwhere to read data to transmit
max_bytesmaximum number of bytes to transmit
Returns
number of bytes transmitted

Definition at line 456 of file internal.h.

typedef size_t(* UnescapeCallback)(void *cls, struct MHD_Connection *conn, char *uri)

Signature of function called to unescape URIs. See also MHD_http_unescape.

Parameters
clsclosure
connconnection handle
uri0-terminated string to unescape (should be updated)
Returns
length of the resulting string

Definition at line 774 of file internal.h.

Enumeration Type Documentation

States in a state machine for a connection.

Transitions are any-state to CLOSED, any state to state+1, FOOTERS_SENT to INIT. CLOSED is the terminal state and INIT the initial state.

Note that transitions for reading happen only after the input has been processed; transitions for writing happen after the respective data has been put into the write buffer (the write does not have to be completed yet). A transition to CLOSED or INIT requires the write to be complete.

Enumerator:
MHD_CONNECTION_INIT 

Connection just started (no headers received). Waiting for the line with the request type, URL and version.

MHD_CONNECTION_URL_RECEIVED 

1: We got the URL (and request type and version). Wait for a header line.

MHD_CONNECTION_HEADER_PART_RECEIVED 

2: We got part of a multi-line request header. Wait for the rest.

MHD_CONNECTION_HEADERS_RECEIVED 

3: We got the request headers. Process them.

MHD_CONNECTION_HEADERS_PROCESSED 

4: We have processed the request headers. Send 100 continue.

MHD_CONNECTION_CONTINUE_SENDING 

5: We have processed the headers and need to send 100 CONTINUE.

MHD_CONNECTION_CONTINUE_SENT 

6: We have sent 100 CONTINUE (or do not need to). Read the message body.

MHD_CONNECTION_BODY_RECEIVED 

7: We got the request body. Wait for a line of the footer.

MHD_CONNECTION_FOOTER_PART_RECEIVED 

8: We got part of a line of the footer. Wait for the rest.

MHD_CONNECTION_FOOTERS_RECEIVED 

9: We received the entire footer. Wait for a response to be queued and prepare the response headers.

MHD_CONNECTION_HEADERS_SENDING 

10: We have prepared the response headers in the writ buffer. Send the response headers.

MHD_CONNECTION_HEADERS_SENT 

11: We have sent the response headers. Get ready to send the body.

MHD_CONNECTION_NORMAL_BODY_READY 

12: We are ready to send a part of a non-chunked body. Send it.

MHD_CONNECTION_NORMAL_BODY_UNREADY 

13: We are waiting for the client to provide more data of a non-chunked body.

MHD_CONNECTION_CHUNKED_BODY_READY 

14: We are ready to send a chunk.

MHD_CONNECTION_CHUNKED_BODY_UNREADY 

15: We are waiting for the client to provide a chunk of the body.

MHD_CONNECTION_BODY_SENT 

16: We have sent the response body. Prepare the footers.

MHD_CONNECTION_FOOTERS_SENDING 

17: We have prepared the response footer. Send it.

MHD_CONNECTION_FOOTERS_SENT 

18: We have sent the response footer. Shutdown or restart.

MHD_CONNECTION_CLOSED 

19: This connection is to be closed.

MHD_CONNECTION_IN_CLEANUP 

20: This connection is finished (only to be freed)

MHD_TLS_CONNECTION_INIT 

The initial connection state for all secure connectoins Handshake messages will be processed in this state & while in the 'MHD_TLS_HELLO_REQUEST' state

Definition at line 298 of file internal.h.

Events we care about with respect to poll/select for file descriptors.

Enumerator:
MHD_POLL_ACTION_NOTHING 

No event interests us.

MHD_POLL_ACTION_IN 

We would like to read.

MHD_POLL_ACTION_OUT 

We would like to write.

Definition at line 83 of file internal.h.

Function Documentation

size_t MHD_http_unescape ( void *  cls,
struct MHD_Connection connection,
char *  val 
)

Process escape sequences ('+'=space, HH) Updates val in place; the result should be UTF-8 encoded and cannot be larger than the input. The result must also still be 0-terminated.

Parameters
clsclosure (use NULL)
connectionhandle to connection, not used
Returns
length of the resulting val (strlen(val) maybe shorter afterwards due to elimination of escape sequences)

Definition at line 118 of file internal.c.

Referenced by MHD_start_daemon_va(), and post_process_urlencoded().

Here is the caller graph for this function:

time_t MHD_monotonic_time ( void  )

Equivalent to time(NULL) but tries to use some sort of monotonic clock that isn't affected by someone setting the system real time clock.

Definition at line 160 of file internal.c.

References NULL.

Referenced by MHD_add_connection(), MHD_connection_handle_idle(), MHD_connection_handle_read(), MHD_connection_handle_write(), MHD_digest_auth_check(), MHD_get_timeout(), MHD_handle_connection(), MHD_queue_auth_fail_response(), MHD_tls_connection_handle_idle(), and run_tls_handshake().

Here is the caller graph for this function:

Variable Documentation