response.c File Reference

Methods for managing response objects. More...

#include "mhd_options.h"
#include "internal.h"
#include "response.h"
#include "mhd_limits.h"
#include "mhd_sockets.h"
#include "mhd_itc.h"
#include "mhd_str.h"
#include "connection.h"
#include "memorypool.h"
#include "mhd_compat.h"

Include dependency graph for response.c:

Go to the source code of this file.

Macros
#define	MHD_NO_DEPRECATION   1
#define	MHD_FILE_READ_BLOCK_SIZE   4096 /* 4k */

Functions
static enum MHD_Result	add_response_entry (struct MHD_Response *response, enum MHD_ValueKind kind, const char *header, const char *content)
_MHD_EXTERN enum MHD_Result	MHD_add_response_header (struct MHD_Response *response, const char *header, const char *content)
_MHD_EXTERN enum MHD_Result	MHD_add_response_footer (struct MHD_Response *response, const char *footer, const char *content)
_MHD_EXTERN enum MHD_Result	MHD_del_response_header (struct MHD_Response *response, const char *header, const char *content)
_MHD_EXTERN int	MHD_get_response_headers (struct MHD_Response *response, MHD_KeyValueIterator iterator, void *iterator_cls)
_MHD_EXTERN const char *	MHD_get_response_header (struct MHD_Response *response, const char *key)
bool	MHD_check_response_header_token_ci (const struct MHD_Response *response, const char *key, size_t key_len, const char *token, size_t token_len)
_MHD_EXTERN struct MHD_Response *	MHD_create_response_from_callback (uint64_t size, size_t block_size, MHD_ContentReaderCallback crc, void *crc_cls, MHD_ContentReaderFreeCallback crfc)
enum MHD_Result	MHD_set_response_options (struct MHD_Response *response, enum MHD_ResponseFlags flags,...)
static ssize_t	file_reader (void *cls, uint64_t pos, char *buf, size_t max)
static ssize_t	pipe_reader (void *cls, uint64_t pos, char *buf, size_t max)
static void	free_callback (void *cls)
struct MHD_Response *	MHD_create_response_from_fd_at_offset (size_t size, int fd, off_t offset)
_MHD_EXTERN struct MHD_Response *	MHD_create_response_from_fd_at_offset64 (uint64_t size, int fd, uint64_t offset)
_MHD_EXTERN struct MHD_Response *	MHD_create_response_from_pipe (int fd)
_MHD_EXTERN struct MHD_Response *	MHD_create_response_from_fd (size_t size, int fd)
_MHD_EXTERN struct MHD_Response *	MHD_create_response_from_fd64 (uint64_t size, int fd)
struct MHD_Response *	MHD_create_response_from_data (size_t size, void *data, int must_free, int must_copy)
_MHD_EXTERN struct MHD_Response *	MHD_create_response_from_buffer (size_t size, void *buffer, enum MHD_ResponseMemoryMode mode)
_MHD_EXTERN struct MHD_Response *	MHD_create_response_from_buffer_with_free_callback (size_t size, void *buffer, MHD_ContentReaderFreeCallback crfc)
_MHD_EXTERN void	MHD_destroy_response (struct MHD_Response *response)
void	MHD_increment_response_rc (struct MHD_Response *response)

Detailed Description

Methods for managing response objects.

Author

Daniel Pittman

Christian Grothoff

Karlson2k (Evgeny Grin)

Definition in file response.c.

Macro Definition Documentation

MHD_FILE_READ_BLOCK_SIZE

#define MHD_FILE_READ_BLOCK_SIZE   4096 /* 4k */

Size of single file read operation for file-backed responses.

Definition at line 67 of file response.c.

MHD_NO_DEPRECATION

#define MHD_NO_DEPRECATION   1

Definition at line 27 of file response.c.

Function Documentation

add_response_entry()

static enum MHD_Result add_response_entry ( struct MHD_Response *  response, enum MHD_ValueKind  kind, const char *  header, const char *  content  )

static

Add a header or footer line to the response.

Parameters

response	response to add a header to
kind	header or footer
header	the header to add
content	value to add

Returns

MHD_NO on error (i.e. invalid header or content format).

Definition at line 1 of file response.c.

file_reader()

static ssize_t file_reader ( void *  cls, uint64_t  pos, char *  buf, size_t  max  )

static

Given a file descriptor, read data from the file to generate the response.

Parameters

cls	pointer to the response
pos	offset in the file to access
buf	where to write the data
max	number of bytes to write at most

Returns

number of bytes written

Definition at line 452 of file response.c.

References MHD_Response::fd, MHD_Response::fd_off, INT32_MAX, MHD_CONTENT_READER_END_OF_STREAM, MHD_CONTENT_READER_END_WITH_ERROR, and SSIZE_MAX.

Referenced by MHD_create_response_from_fd_at_offset64().

Here is the caller graph for this function:

free_callback()

static void free_callback ( void *  cls )

static

Destroy file reader context. Closes the file descriptor.

Parameters

cls	pointer to file descriptor

Definition at line 575 of file response.c.

References MHD_Response::fd.

Referenced by MHD_create_response_from_fd_at_offset64(), and MHD_create_response_from_pipe().

Here is the caller graph for this function:

MHD_check_response_header_token_ci()

bool MHD_check_response_header_token_ci	(	const struct MHD_Response *	response,
		const char *	key,
		size_t	key_len,
		const char *	token,
		size_t	token_len
	)

Check whether response header contains particular token.

Token could be surrounded by spaces and tabs and delimited by comma. Case-insensitive match used for header names and tokens.

Parameters

response	the response to query
key	header name
key_len	the length of key, not including optional terminating null-character.
token	the token to find
token_len	the length of token, not including optional terminating null-character.

Returns

true if token is found in specified header, false otherwise

Definition at line 323 of file response.c.

References MHD_Response::first_header, MHD_HTTP_Header::header, MHD_HTTP_Header::header_size, MHD_HTTP_Header::kind, mhd_assert, MHD_HEADER_KIND, MHD_str_equal_caseless_bin_n_(), MHD_str_has_token_caseless_(), MHD_HTTP_Header::next, NULL, and MHD_HTTP_Header::value.

Here is the call graph for this function:

MHD_increment_response_rc()

void MHD_increment_response_rc

(

struct MHD_Response *

response

)

Increments the reference counter for the response.

Parameters

response

object to modify

Definition at line 1308 of file response.c.

References MHD_mutex_lock_chk_, MHD_mutex_unlock_chk_, MHD_Response::mutex, and MHD_Response::reference_count.

MHD_set_response_options()

enum MHD_Result MHD_set_response_options	(	struct MHD_Response *	response,
		enum MHD_ResponseFlags	flags,
			...
	)

Set special flags and options for a response.

Parameters

response	the response to modify
flags	to set for the response
...	MHD_RO_END terminated list of options

Returns

MHD_YES on success, MHD_NO on error

Definition at line 375 of file response.c.

pipe_reader()

static ssize_t pipe_reader ( void *  cls, uint64_t  pos, char *  buf, size_t  max  )

static

Given a pipe descriptor, read data from the pipe to generate the response.

Parameters

cls	pointer to the response
pos	offset in the pipe to access (ignored)
buf	where to write the data
max	number of bytes to write at most

Returns

number of bytes written

Definition at line 540 of file response.c.

References MHD_Response::fd, MHD_CONTENT_READER_END_OF_STREAM, MHD_CONTENT_READER_END_WITH_ERROR, SSIZE_MAX, and UINT_MAX.

Referenced by MHD_create_response_from_pipe().

Here is the caller graph for this function: