generation of responses

Typedefs

typedef void(* MHD_ContentReaderFreeCallback )(void *cls)

Enumerations

enum  MHD_ResponseMemoryMode { MHD_RESPMEM_PERSISTENT, MHD_RESPMEM_MUST_FREE, MHD_RESPMEM_MUST_COPY }

Functions

int MHD_queue_response (struct MHD_Connection *connection, unsigned int status_code, struct MHD_Response *response)
struct MHD_ResponseMHD_create_response_from_callback (uint64_t size, size_t block_size, MHD_ContentReaderCallback crc, void *crc_cls, MHD_ContentReaderFreeCallback crfc)
struct MHD_ResponseMHD_create_response_from_data (size_t size, void *data, int must_free, int must_copy)
struct MHD_ResponseMHD_create_response_from_buffer (size_t size, void *buffer, enum MHD_ResponseMemoryMode mode)
struct MHD_ResponseMHD_create_response_from_fd (size_t size, int fd)
struct MHD_ResponseMHD_create_response_from_fd_at_offset (size_t size, int fd, off_t offset)
void MHD_destroy_response (struct MHD_Response *response)
int MHD_add_response_header (struct MHD_Response *response, const char *header, const char *content)
int MHD_add_response_footer (struct MHD_Response *response, const char *footer, const char *content)
int MHD_del_response_header (struct MHD_Response *response, const char *header, const char *content)
int MHD_get_response_headers (struct MHD_Response *response, MHD_KeyValueIterator iterator, void *iterator_cls)
const char * MHD_get_response_header (struct MHD_Response *response, const char *key)

Detailed Description

MHD API used to generate responses.


Typedef Documentation

typedef void(* MHD_ContentReaderFreeCallback)(void *cls)

This method is called by libmicrohttpd if we are done with a content reader. It should be used to free resources associated with the content reader.

Parameters:
cls closure

Definition at line 1238 of file microhttpd.h.


Enumeration Type Documentation

Specification for how MHD should treat the memory buffer given for the response.

Enumerator:
MHD_RESPMEM_PERSISTENT 

Buffer is a persistent (static/global) buffer that won't change for at least the lifetime of the response, MHD should just use it, not free it, not copy it, just keep an alias to it.

MHD_RESPMEM_MUST_FREE 

Buffer is heap-allocated with `malloc()` (or equivalent) and should be freed by MHD after processing the response has concluded (response reference counter reaches zero).

MHD_RESPMEM_MUST_COPY 

Buffer is in transient memory, but not on the heap (for example, on the stack or non-`malloc()` allocated) and only valid during the call to MHD_create_response_from_buffer. MHD must make its own private copy of the data for processing.

Definition at line 1681 of file microhttpd.h.


Function Documentation

int MHD_add_response_footer ( struct MHD_Response response,
const char *  footer,
const char *  content 
)

Add a footer line to the response.

Parameters:
response response to remove a header from
footer the footer to delete
content value to delete
Returns:
MHD_NO on error (i.e. invalid footer or content format).

Definition at line 110 of file response.c.

References add_response_entry(), and MHD_FOOTER_KIND.

Here is the call graph for this function:

int MHD_add_response_header ( struct MHD_Response response,
const char *  header,
const char *  content 
)

Add a header line to the response.

Parameters:
response response to add a header to
header the header to add
content value to add
Returns:
MHD_NO on error (i.e. invalid header or content format), or out of memory

Add a header line to the response.

Parameters:
response response to add a header to
header the header to add
content value to add
Returns:
MHD_NO on error (i.e. invalid header or content format).

Definition at line 90 of file response.c.

References add_response_entry(), and MHD_HEADER_KIND.

Referenced by add_extra_headers(), MHD_queue_auth_fail_response(), and MHD_queue_basic_auth_fail_response().

Here is the call graph for this function:

Here is the caller graph for this function:

struct MHD_Response * MHD_create_response_from_buffer ( size_t  size,
void *  buffer,
enum MHD_ResponseMemoryMode  mode 
) [read]

Create a response object. The response object can be extended with header information and then be used any number of times.

Parameters:
size size of the data portion of the response
buffer size bytes containing the response's data portion
mode flags for buffer management
Returns:
NULL on error (i.e. invalid arguments, out of memory)

Definition at line 423 of file response.c.

References MHD_create_response_from_data(), MHD_RESPMEM_MUST_COPY, and MHD_RESPMEM_MUST_FREE.

Referenced by parse_connection_headers(), and transmit_error_response().

Here is the call graph for this function:

Here is the caller graph for this function:

struct MHD_Response * MHD_create_response_from_callback ( uint64_t  size,
size_t  block_size,
MHD_ContentReaderCallback  crc,
void *  crc_cls,
MHD_ContentReaderFreeCallback  crfc 
) [read]

Create a response object. The response object can be extended with header information and then be used any number of times.

Parameters:
size size of the data portion of the response, MHD_SIZE_UNKNOWN for unknown
block_size preferred block size for querying crc (advisory only, MHD may still call crc using smaller chunks); this is essentially the buffer size used for IO, clients should pick a value that is appropriate for IO and memory performance requirements
crc callback to use to obtain response data
crc_cls extra argument to crc
crfc callback to call to free crc_cls resources
Returns:
NULL on error (i.e. invalid arguments, out of memory)

Definition at line 231 of file response.c.

References MHD_Response::crc, MHD_Response::crc_cls, MHD_Response::crfc, MHD_Response::data, MHD_Response::data_buffer_size, MHD_Response::fd, MHD_Response::mutex, NULL, MHD_Response::reference_count, and MHD_Response::total_size.

Referenced by MHD_create_response_from_fd_at_offset().

Here is the caller graph for this function:

struct MHD_Response * MHD_create_response_from_data ( size_t  size,
void *  data,
int  must_free,
int  must_copy 
) [read]

Create a response object. The response object can be extended with header information and then be used any number of times.

Parameters:
size size of the data portion of the response
data the data itself
must_free libmicrohttpd should free data when done
must_copy libmicrohttpd must make a copy of data right away, the data maybe released anytime after this call returns
Returns:
NULL on error (i.e. invalid arguments, out of memory)

Create a response object. The response object can be extended with header information and then be used any number of times.

Parameters:
size size of the data portion of the response
data the data itself
must_free libmicrohttpd should free data when done
must_copy libmicrohttpd must make a copy of data right away, the data maybe released anytime after this call returns
Returns:
NULL on error (i.e. invalid arguments, out of memory)

Definition at line 372 of file response.c.

References MHD_Response::crc, MHD_Response::crc_cls, MHD_Response::crfc, MHD_Response::data, MHD_Response::data_size, MHD_Response::fd, MHD_YES, MHD_Response::mutex, NULL, MHD_Response::reference_count, and MHD_Response::total_size.

Referenced by MHD_create_response_from_buffer().

Here is the caller graph for this function:

struct MHD_Response * MHD_create_response_from_fd ( size_t  size,
int  fd 
) [read]

Create a response object. The response object can be extended with header information and then be used any number of times.

Parameters:
size size of the data portion of the response
fd file descriptor referring to a file on disk with the data; will be closed when response is destroyed; fd should be in 'blocking' mode
Returns:
NULL on error (i.e. invalid arguments, out of memory)

Create a response object. The response object can be extended with header information and then be used any number of times.

Parameters:
size size of the data portion of the response
fd file descriptor referring to a file on disk with the data
Returns:
NULL on error (i.e. invalid arguments, out of memory)

Definition at line 350 of file response.c.

References MHD_create_response_from_fd_at_offset().

Here is the call graph for this function:

struct MHD_Response * MHD_create_response_from_fd_at_offset ( size_t  size,
int  fd,
off_t  offset 
) [read]

Create a response object. The response object can be extended with header information and then be used any number of times.

Parameters:
size size of the data portion of the response
fd file descriptor referring to a file on disk with the data; will be closed when response is destroyed; fd should be in 'blocking' mode
offset offset to start reading from in the file; Be careful! `off_t` may have been compiled to be a 64-bit variable for MHD, in which case your application also has to be compiled using the same options! Read the MHD manual for more details.
Returns:
NULL on error (i.e. invalid arguments, out of memory)

Definition at line 320 of file response.c.

References MHD_Response::crc_cls, MHD_Response::fd, MHD_Response::fd_off, file_reader(), free_callback(), MHD_create_response_from_callback(), and NULL.

Referenced by MHD_create_response_from_fd().

Here is the call graph for this function:

Here is the caller graph for this function:

int MHD_del_response_header ( struct MHD_Response response,
const char *  header,
const char *  content 
)

Delete a header (or footer) line from the response.

Parameters:
response response to remove a header from
header the header to delete
content value to delete
Returns:
MHD_NO on error (no such header known)

Definition at line 130 of file response.c.

References MHD_Response::first_header, MHD_HTTP_Header::header, MHD_NO, MHD_YES, MHD_HTTP_Header::next, NULL, and MHD_HTTP_Header::value.

void MHD_destroy_response ( struct MHD_Response response  ) 

Destroy a response object and associated resources. Note that libmicrohttpd may keep some of the resources around if the response is still in the queue for some clients, so the memory may not necessarily be freed immediatley.

Parameters:
response response to destroy

Definition at line 444 of file response.c.

References MHD_Response::crc_cls, MHD_Response::crfc, MHD_Response::first_header, MHD_HTTP_Header::header, MHD_Response::mutex, MHD_HTTP_Header::next, NULL, MHD_Response::reference_count, and MHD_HTTP_Header::value.

Referenced by cleanup_connection(), MHD_cleanup_connections(), MHD_connection_handle_idle(), MHD_handle_connection(), parse_connection_headers(), and transmit_error_response().

Here is the caller graph for this function:

const char * MHD_get_response_header ( struct MHD_Response response,
const char *  key 
)

Get a particular header (or footer) from the response.

Parameters:
response response to query
key which header to get
Returns:
NULL if header does not exist

Definition at line 200 of file response.c.

References MHD_Response::first_header, MHD_HTTP_Header::header, MHD_HTTP_Header::next, NULL, and MHD_HTTP_Header::value.

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

Here is the caller graph for this function:

int MHD_get_response_headers ( struct MHD_Response response,
MHD_KeyValueIterator  iterator,
void *  iterator_cls 
)

Get all of the headers (and footers) added to a response.

Parameters:
response response to query
iterator callback to call on each header; maybe NULL (then just count headers)
iterator_cls extra argument to iterator
Returns:
number of entries iterated over

Definition at line 173 of file response.c.

References MHD_Response::first_header, MHD_HTTP_Header::header, MHD_HTTP_Header::kind, MHD_YES, MHD_HTTP_Header::next, NULL, and MHD_HTTP_Header::value.

int MHD_queue_response ( struct MHD_Connection connection,
unsigned int  status_code,
struct MHD_Response response 
)

Queue a response to be transmitted to the client (as soon as possible but after MHD_AccessHandlerCallback returns).

Parameters:
connection the connection identifying the client
status_code HTTP status code (i.e. MHD_HTTP_OK)
response response to transmit
Returns:
MHD_NO on error (i.e. reply already sent), MHD_YES on success or if message has been queued

Definition at line 2716 of file connection.c.

References MHD_Connection::in_idle, MHD_Connection::method, MHD_CONNECTION_FOOTERS_RECEIVED, MHD_connection_handle_idle(), MHD_CONNECTION_HEADERS_PROCESSED, MHD_HTTP_METHOD_HEAD, MHD_HTTP_METHOD_POST, MHD_HTTP_METHOD_PUT, MHD_increment_response_rc(), MHD_NO, MHD_YES, NULL, MHD_Connection::read_closed, MHD_Connection::response, MHD_Connection::response_write_position, MHD_Connection::responseCode, MHD_Connection::state, and MHD_Response::total_size.

Referenced by MHD_queue_auth_fail_response(), MHD_queue_basic_auth_fail_response(), parse_connection_headers(), and transmit_error_response().

Here is the call graph for this function:

Here is the caller graph for this function:


Generated on 17 Oct 2014 for GNU libmicrohttpd by  doxygen 1.6.1