source/http/inc/http_platform.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 _PM_HTTP_H
#define _PM_HTTP_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-----------------------------------------*/

/* HTTP request type */
typedef enum
{
   HTTP_REQUEST_GET,
   HTTP_REQUEST_HEAD,
   HTTP_REQUEST_POST,
   HTTP_REQUEST_STREAM
} E_HttpRequestType;

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

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

E_HttpErr HP_Initialise(void);


E_HttpErr HP_SetUserAgent(U8BIT *user_agent);


E_HttpErr HP_SetTimeout(U16BIT timeout);


E_HttpErr HP_CreateRequest(U8BIT *url, E_HttpRequestType type,
   void **handle);


E_HttpErr HP_StartRequest(void *handle);


E_HttpErr HP_ResumeRequest(void *handle);


E_HttpErr HP_StopRequest(void *handle);


E_HttpErr HP_DestroyRequest(void *handle);


E_HttpErr HP_SetUserData(void *handle, void *userdata);


E_HttpErr HP_AddHeader(void *handle, U8BIT *header);


E_HttpErr HP_SetPostData(void *handle, U8BIT *postdata);


E_HttpErr HP_SetRange(void *handle, U8BIT *range);


E_HttpErr HP_GetRedirectUrl(void *handle, U8BIT **url);


E_HttpErr HP_AddTlsCertificate(U8BIT *cert, U32BIT len);


E_HttpErr HP_ClearTlsCertificates(void);


E_HttpErr HP_WaitForAction(void);


E_HttpErr HP_Process(U16BIT *active_count);


void HP_HeaderCallback(void *userdata, S32BIT response_code,
   U8BIT *data, U32BIT len);


BOOLEAN HP_ContentCallback(void *userdata, U8BIT *data, U32BIT len);


void HP_EndCallback(void *userdata, E_HttpStatus status);


E_HttpErr HP_Terminate(void);


#endif /*_PM_HTTP_H*/