HTTP Request

Collaboration diagram for HTTP Request:

Data Structures
struct	http_param_s
	HTTP uri parameter object. More...
struct	http_request
	HTTP request object. More...

Typedefs
typedef struct http_request	http_request_s
	HTTP request object. More...
typedef void(*	router_fn) (http_request_s *req)

Functions
http_request_s *	http_request_new (router_fn router)
	Creates a new HTTP request instance. More...
void	http_request_free (http_request_s *req)
	Safely frees an HTTP request instance. More...
uint8_t	http_request_parse (http_request_s *req, struct pbuf *p)
	Extracts and parses HTTP method headers and content from received data and calls the router function defined during initialisation. router function is in charge of generating response data. It is up to the user to implement such function. More...

Detailed Description

An HTTP request contains information relative to a received HTTP frame such as its method, header fields and content. Once HTTP requests should be processed through a router function. During routing step it is up to the user to forge response data and forward it to the http request instance to be sent back over to the sender of the request.

Typedef Documentation

http_request_s

typedef struct http_request http_request_s

HTTP request object.

Definition at line 22 of file http_request.h.

router_fn

typedef void(* router_fn) (http_request_s *req)

HTTP request routing function

Definition at line 23 of file http_request.h.

Function Documentation

http_request_free()

void http_request_free

(

http_request_s *

req

)

Safely frees an HTTP request instance.

Parameters

req	HTTP request instance to be freed

Definition at line 247 of file http_request.c.

http_request_new()

http_request_s * http_request_new

(

router_fn

router

)

Creates a new HTTP request instance.

Parameters

router

The router function through which the request should be handled.

Returns

http_request_s the create HTTP request instance

See also

http_init function for further information

Definition at line 224 of file http_request.c.

http_request_parse()

uint8_t http_request_parse	(	http_request_s *	req,
		struct pbuf *	p
	)

Extracts and parses HTTP method headers and content from received data and calls the router function defined during initialisation. router function is in charge of generating response data. It is up to the user to implement such function.

Parameters

req	http request instance
*p	pointer to the received data

Returns

err_t error code to be forwarded to the stack

See also

err.h for further information regarding the TCIP/IP stack error codes

Definition at line 293 of file http_request.c.