source/http/inc/http_interface.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2010 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _HTTP_INTERFACE_H
#define _HTTP_INTERFACE_H


/*---includes for this file--------------------------------------------------*/
#include <techtype.h>
#include "httptype.h"

/*---Constant and macro definitions for public use---------------------------*/

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/
typedef struct
{
   E_HttpStatus status;
   S32BIT code;
   U8BIT *data;
   U32BIT data_len;
} HttpResponse_t;

typedef struct
{
   void (*parse)(void *data, U32BIT data_len, char *url);
   U8BIT *(*generate_header)(U8BIT * url);
   void (*ack_header)(U8BIT *header);
} HttpCookieManager_t;


/* Used to reference a request within the http interface component from
 * the core module
 */
typedef struct HttpRequest_tag *HttpRequest_t;

typedef BOOLEAN (*HttpCallback_t)(void *userdata, U32BIT request_id,
   HttpResponse_t *response);

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

E_HttpErr httpOpen(U32BIT task_priority);


void httpSetCookieManager(HttpCookieManager_t *manager);


void httpSetUserAgent(U8BIT *user_agent);


void httpClearTlsCertStore(void);


void httpAddTlsCertToStore(U8BIT *certData, U32BIT certLen);


U32BIT httpGetTlsCertStoreCount(void);


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


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


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


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


void httpStartRequest(HttpRequest_t request);


U8BIT* httpGetRequestRedirect(HttpRequest_t request);


void httpResumeRequest(HttpRequest_t request);


void httpStopRequest(HttpRequest_t request);


void httpDestroyRequest(HttpRequest_t request);


void httpClose(void);


#endif /*_HTTP_INTERFACE_H*/