source/http/inc/http_interface.h File Reference

Manages the interface between MHEG5 Engine and the HTTP component. More...

#include <techtype.h>
#include "httptype.h"

Go to the source code of this file.

Data Structures
struct	HttpResponse_t
struct	HttpCookieManager_t
Typedefs
typedef struct HttpRequest_tag *	HttpRequest_t
typedef BOOLEAN(*	HttpCallback_t )(void *userdata, U32BIT request_id, HttpResponse_t *response)
Functions
E_HttpErr	httpOpen (U32BIT task_priority)
	Open the HTTP interface.
void	httpSetCookieManager (HttpCookieManager_t *manager)
	Set cookie manager for HTTP connections.
void	httpSetUserAgent (U8BIT *user_agent)
	Set User Agent for HTTP connections.
void	httpClearTlsCertStore (void)
	Clear TLS certificate store.
void	httpAddTlsCertToStore (U8BIT *certData, U32BIT certLen)
	Add TLS certificate to store.
U32BIT	httpGetTlsCertStoreCount (void)
	Return number of TLS certificate in the certificate store.
HttpRequest_t	httpCreateGetRequest (U8BIT *url, U8BIT cachePriority, HttpCallback_t callback, U32BIT request_id, void *userdata)
	Create an HTTP GET request.
HttpRequest_t	httpCreateHeadRequest (U8BIT *url, HttpCallback_t callback, U32BIT request_id, void *userdata)
	Create an HTTP HEAD request.
HttpRequest_t	httpCreatePostRequest (U8BIT *url, U8BIT *data, HttpCallback_t callback, U32BIT request_id, void *userdata)
	Create an HTTP POST request.
HttpRequest_t	httpCreateStreamRequest (U8BIT *url, U8BIT *range, HttpCallback_t header_callback, HttpCallback_t callback, U32BIT request_id, void *userdata)
	Create an HTTP request for stream media.
void	httpStartRequest (HttpRequest_t request)
	Start an HTTP request. Everything related to the request is passed through the callback that was registered when the request was created.
U8BIT *	httpGetRequestRedirect (HttpRequest_t request)
	Return the URL that the request is redirected to (valid only for response codes of 3xx).
void	httpResumeRequest (HttpRequest_t request)
	Resume an HTTP request. A request can be paused by returning FALSE from the content callback to tell the HTTP client that the data was not processed. Once the request is paused, it will not be resumed automatically - this function has to be called explicitly.
void	httpStopRequest (HttpRequest_t request)
	Stop an HTTP request. This function does not destroy the request; this is done using httpDestroyRequest.
void	httpDestroyRequest (HttpRequest_t request)
	Destroy an HTTP request.
void	httpClose (void)
	Close the HTTP interface.

---

Detailed Description

Manages the interface between MHEG5 Engine and the HTTP component.

Date:

22/2/2010

Author:

Omri Barel

---

Function Documentation

void httpAddTlsCertToStore	(	U8BIT *	certData,
		U32BIT	certLen
	)

Add TLS certificate to store.

Returns:

Nothing

void httpClearTlsCertStore

(

void

)

Clear TLS certificate store.

Returns:

Nothing

void httpClose

(

void

)

Close the HTTP interface.

Returns:

Nothing

HttpRequest_t httpCreateGetRequest	(	U8BIT *	url,
		U8BIT	cachePriority,
		HttpCallback_t	callback,
		U32BIT	request_id,
		void *	userdata
	)

Create an HTTP GET request.

Parameters:

url	URL for the request. The URL must be percent-encoded according to IETF RFC 1738.
cachePriority	cache priority for content. The meaning is according to section 17.5 of the D-Book. However, 0 is always no-cache.
callback	callback for information and data
request_id	request ID provided by the client
userdata	user data which is passed to the callback

Returns:

Request handle, or NULL if request cannot be created

HttpRequest_t httpCreateHeadRequest	(	U8BIT *	url,
		HttpCallback_t	callback,
		U32BIT	request_id,
		void *	userdata
	)

Create an HTTP HEAD request.

Parameters:

url	URL for the request. The URL must be percent-encoded according to IETF RFC 1738.
callback	callback for information and data
request_id	request ID provided by the client
userdata	user data which is passed to the callback

Returns:

Request handle, or NULL if request cannot be created

HttpRequest_t httpCreatePostRequest	(	U8BIT *	url,
		U8BIT *	data,
		HttpCallback_t	callback,
		U32BIT	request_id,
		void *	userdata
	)

Create an HTTP POST request.

Parameters:

url	URL for the request. The URL must be percent-encoded according to IETF RFC 1738.
data	POST data. The data must be percent-encoded according to HTTP 4.01 and IETF RFC 3986.
callback	callback for information and data
request_id	request ID provided by the client
userdata	user data which is passed to the callback

Returns:

Request handle, or NULL if request cannot be created

HttpRequest_t httpCreateStreamRequest	(	U8BIT *	url,
		U8BIT *	range,
		HttpCallback_t	header_callback,
		HttpCallback_t	callback,
		U32BIT	request_id,
		void *	userdata
	)

Create an HTTP request for stream media.

Parameters:

url	URL for the request. The URL must be percent-encoded according to IETF RFC 1738.
range	range of data to retrieve "X-Y"
header_cb	callback for header information and data
callback	callback for information and data
request_id	request ID provided by the client
userdata	user data which is passed to the callback

Returns:

Request handle, or NULL if request cannot be created

void httpDestroyRequest

(

HttpRequest_t

request

)

Destroy an HTTP request.

Returns:

Nothing

U8BIT* httpGetRequestRedirect

(

HttpRequest_t

request

)

Return the URL that the request is redirected to (valid only for response codes of 3xx).

Parameters:

request

request handle

Returns:

Pointer to redirection URL

U32BIT httpGetTlsCertStoreCount

(

void

)

Return number of TLS certificate in the certificate store.

Returns:

Nothing

E_HttpErr httpOpen

(

U32BIT

task_priority

)

Open the HTTP interface.

Parameters:

task_priority

HTTP task priority

Returns:

HTTP_OK if the interface is opened HTTP_ERR_INTERNAL if the interface cannot be opened

void httpResumeRequest

(

HttpRequest_t

request

)

Resume an HTTP request. A request can be paused by returning FALSE from the content callback to tell the HTTP client that the data was not processed. Once the request is paused, it will not be resumed automatically - this function has to be called explicitly.

Parameters:

request

request handle

Returns:

Nothing

void httpSetCookieManager

(

HttpCookieManager_t *

manager

)

Set cookie manager for HTTP connections.

Parameters:

manager

Cookie manager

Returns:

Nothing

void httpSetUserAgent

(

U8BIT *

user_agent

)

Set User Agent for HTTP connections.

Parameters:

user_agent

User Agent string

Returns:

Nothing

void httpStartRequest

(

HttpRequest_t

request

)

Start an HTTP request. Everything related to the request is passed through the callback that was registered when the request was created.

Parameters:

request

request handle

Returns:

Nothing

void httpStopRequest

(

HttpRequest_t

request

)

Stop an HTTP request. This function does not destroy the request; this is done using httpDestroyRequest.

Parameters:

request

request handle

Returns:

Nothing