HTTP response

Collaboration diagram for HTTP response:

Data Structures
struct	http_response_s
	HTTP response structure object. More...

Macros
#define	HTTP_RESPONSE_CONTENT_LENGTH_MAX_LENGTH   5

Enumerations
enum	http_response_static_state {   HTTP_RESPONSE_IS_DYNAMIC ,   HTTP_RESPONSE_IS_STATIC }
	Whether the HTTP response conveys static data or not. This is very importnt as it will be used to allocate and free the response's data pointer in case the response data needs to be dynamimc. More...

Functions
http_response_s *	http_response_new (void)
	Creates a new HTTP response instance. More...
void	http_response_free (http_response_s *res)
	Safely frees an HTTP response instance. More...
uint32_t	http_response_get_bytes_left (http_response_s *res)
	Returns the amount of bytes left to be processed. More...
void	http_response_prepare_dynamic (http_response_s *res, http_status_code_e status_code, http_content_types_e content_type, char *content)
	Pre-formats response to HTTP response using provided response header parameters. More...

Detailed Description

Handles generation of both static and dynamic HTTP repsponse frames. Currently supported HTTP versions: HTTP/0.9 and HTTP/1.1.

Macro Definition Documentation

HTTP_RESPONSE_CONTENT_LENGTH_MAX_LENGTH

#define HTTP_RESPONSE_CONTENT_LENGTH_MAX_LENGTH   5

Maximum string length of content length header value

Definition at line 17 of file http_response.h.

Enumeration Type Documentation

http_response_static_state

enum http_response_static_state

Whether the HTTP response conveys static data or not. This is very importnt as it will be used to allocate and free the response's data pointer in case the response data needs to be dynamimc.

Enumerator
HTTP_RESPONSE_IS_DYNAMIC	Sets the HTTP response to be dynamic (enable data pointer memory allocation)
HTTP_RESPONSE_IS_STATIC	Sets the HTTP response to be static (disable data pointer memory allocation)

Definition at line 26 of file http_response.h.

Function Documentation

http_response_free()

void http_response_free

(

http_response_s *

res

)

Safely frees an HTTP response instance.

Parameters

res	HTTP response instance to be freed

Definition at line 61 of file http_response.c.

http_response_get_bytes_left()

uint32_t http_response_get_bytes_left

(

http_response_s *

res

)

Returns the amount of bytes left to be processed.

Warning

this function does not affect the current instance data pointer index. this parameter is incremented during the server send process.

Parameters

res	HTTP response instance to be freed

Returns

uint32_t bytes ledt count

Definition at line 84 of file http_response.c.

http_response_new()

http_response_s * http_response_new

(

void

)

Creates a new HTTP response instance.

Returns

http_response_s* pointer to the created HTTP response instance

Definition at line 43 of file http_response.c.

http_response_prepare_dynamic()

void http_response_prepare_dynamic	(	http_response_s *	res,
		http_status_code_e	status_code,
		http_content_types_e	content_type,
		char *	content
	)

Pre-formats response to HTTP response using provided response header parameters.

Parameters

*res	pointer to the response to be prepared
status_code	response's HTTP status code
content_type	the response's content type
content	the response's content

Warning

while it might be tempting, DO NOT USE STRING FUNCTIONS, they are not thread safe and therefore not suitable to be used within the execution of the TCP/IP task thread. http_response_dynamic_cat function will help dynamically allocating and concatenating new string valuehttp_response_prepare_dynamics to the responses' data pointer.

See also

http_defs.h for further information regarding HTTP header definitions

Definition at line 102 of file http_response.c.