GNU libmicrohttpd
0.9.59
|
Typedefs | |
typedef void(* | MHD_ContentReaderFreeCallback) (void *cls) |
Enumerations | |
enum | MHD_ResponseMemoryMode { MHD_RESPMEM_PERSISTENT, MHD_RESPMEM_MUST_FREE, MHD_RESPMEM_MUST_COPY } |
MHD API used to generate responses.
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.
cls | closure |
Definition at line 2063 of file microhttpd.h.
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 |
MHD_RESPMEM_MUST_COPY | Buffer is in transient memory, but not on the heap (for example, on the stack or non- |
Definition at line 2671 of file microhttpd.h.
_MHD_DEPR_FUNC | ( | "MHD_create_response_from_data() is | deprecated, |
use MHD_create_response_from_buffer()" | |||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
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 |
_MHD_DEPR_FUNC | ( | "Function MHD_create_response_from_fd_at_offset() is | deprecated, |
use MHD_create_response_from_fd_at_offset64()" | |||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
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. |
int MHD_add_response_footer | ( | struct MHD_Response * | response, |
const char * | footer, | ||
const char * | content | ||
) |
Add a footer line to the response.
response | response to remove a header from |
footer | the footer to delete |
content | value to delete |
Definition at line 139 of file response.c.
References add_response_entry(), and MHD_FOOTER_KIND.
int MHD_add_response_header | ( | struct MHD_Response * | response, |
const char * | header, | ||
const char * | content | ||
) |
Add a header line to the response.
response | response to add a header to |
header | the header to add |
content | value to add |
Add a header line to the response.
response | response to add a header to |
header | the header to add |
content | value to add |
Definition at line 118 of file response.c.
References add_response_entry(), MHD_HTTP_Header::header, and MHD_HEADER_KIND.
Referenced by MHD_queue_auth_fail_response(), and MHD_queue_basic_auth_fail_response().
struct MHD_Response * MHD_create_response_from_buffer | ( | size_t | size, |
void * | buffer, | ||
enum MHD_ResponseMemoryMode | mode | ||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
size | size of the data portion of the response |
buffer | size bytes containing the response's data portion |
mode | flags for buffer management |
Definition at line 671 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().
struct MHD_Response * MHD_create_response_from_callback | ( | uint64_t | size, |
size_t | block_size, | ||
MHD_ContentReaderCallback | crc, | ||
void * | crc_cls, | ||
MHD_ContentReaderFreeCallback | crfc | ||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
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 |
Definition at line 316 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_calloc_(), MHD_Response::mutex, NULL, MHD_Response::reference_count, and MHD_Response::total_size.
Referenced by MHD_create_response_from_fd_at_offset64().
struct MHD_Response* MHD_create_response_from_data | ( | size_t | size, |
void * | data, | ||
int | must_free, | ||
int | must_copy | ||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
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 |
Definition at line 617 of file response.c.
References MHD_Response::crc_cls, MHD_Response::crfc, MHD_Response::data, data, MHD_Response::data_size, MHD_Response::fd, MHD_calloc_(), MHD_mutex_destroy_chk_, MHD_YES, must_copy, must_free, MHD_Response::mutex, NULL, MHD_Response::reference_count, and MHD_Response::total_size.
Referenced by MHD_create_response_from_buffer().
struct MHD_Response * MHD_create_response_from_fd | ( | size_t | size, |
int | fd | ||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
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 |
Create a response object. The response object can be extended with header information and then be used any number of times.
size | size of the data portion of the response |
fd | file descriptor referring to a file on disk with the data |
Definition at line 570 of file response.c.
References fd, and MHD_create_response_from_fd_at_offset64().
_MHD_EXTERN struct MHD_Response * MHD_create_response_from_fd64 | ( | uint64_t | size, |
int | fd | ||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
size | size of the data portion of the response; sizes larger than 2 GiB may be not supported by OS or MHD build; see MHD_FEATURE_LARGE_FILE |
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 |
Definition at line 593 of file response.c.
References fd, and MHD_create_response_from_fd_at_offset64().
struct MHD_Response* MHD_create_response_from_fd_at_offset | ( | size_t | size, |
int | fd, | ||
off_t | offset | ||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
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. |
Definition at line 501 of file response.c.
References fd, MHD_create_response_from_fd_at_offset64(), and offset.
_MHD_EXTERN struct MHD_Response * MHD_create_response_from_fd_at_offset64 | ( | uint64_t | size, |
int | fd, | ||
uint64_t | offset | ||
) |
Create a response object. The response object can be extended with header information and then be used any number of times.
size | size of the data portion of the response; sizes larger than 2 GiB may be not supported by OS or MHD build; see MHD_FEATURE_LARGE_FILE |
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; reading file beyond 2 GiB may be not supported by OS or MHD build; see MHD_FEATURE_LARGE_FILE |
Definition at line 528 of file response.c.
References MHD_Response::crc_cls, MHD_Response::fd, fd, MHD_Response::fd_off, file_reader(), free_callback(), INT32_MAX, MHD_create_response_from_callback(), NULL, and offset.
Referenced by MHD_create_response_from_fd(), MHD_create_response_from_fd64(), and MHD_create_response_from_fd_at_offset().
int MHD_del_response_header | ( | struct MHD_Response * | response, |
const char * | header, | ||
const char * | content | ||
) |
Delete a header (or footer) line from the response.
response | response to remove a header from |
header | the header to delete |
content | value to delete |
Definition at line 160 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.
response | response to destroy |
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 immediately.
response | response to destroy |
Definition at line 1069 of file response.c.
References MHD_Response::crc_cls, MHD_Response::crfc, MHD_Response::first_header, MHD_HTTP_Header::header, MHD_mutex_destroy_chk_, MHD_mutex_lock_chk_, MHD_mutex_unlock_chk_, 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_close_(), MHD_connection_handle_idle(), parse_connection_headers(), thread_main_handle_connection(), and transmit_error_response().
const char * MHD_get_response_header | ( | struct MHD_Response * | response, |
const char * | key | ||
) |
Get a particular header (or footer) from the response.
response | response to query |
key | which header to get |
Definition at line 238 of file response.c.
References MHD_Response::first_header, MHD_HTTP_Header::header, MHD_str_equal_caseless_(), MHD_HTTP_Header::next, NULL, and MHD_HTTP_Header::value.
Referenced by build_header_response().
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.
response | response to query |
iterator | callback to call on each header; maybe NULL (then just count headers) |
iterator_cls | extra argument to iterator |
Definition at line 206 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).
connection | the connection identifying the client |
status_code | HTTP status code (i.e. MHD_HTTP_OK) |
response | response to transmit |
Definition at line 3931 of file connection.c.
References _, MHD_Connection::daemon, MHD_Response::fd, MHD_Connection::in_idle, MHD_Connection::method, MHD_ALLOW_UPGRADE, 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_HTTP_NO_CONTENT, MHD_HTTP_NOT_MODIFIED, MHD_HTTP_OK, MHD_HTTP_SWITCHING_PROTOCOLS, MHD_increment_response_rc(), MHD_NO, MHD_str_equal_caseless_(), MHD_USE_INTERNAL_POLLING_THREAD, MHD_USE_TLS, MHD_YES, NULL, MHD_Daemon::options, MHD_Connection::pid, MHD_Connection::read_closed, MHD_Connection::response, MHD_Connection::response_write_position, MHD_Connection::responseCode, MHD_Daemon::shutdown, MHD_Connection::state, MHD_Connection::suspended, 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().