m2mb_httpc.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef GEPS_INC_HTTP_CLIENT_M2MB_HTTPC_H_
#define GEPS_INC_HTTP_CLIENT_M2MB_HTTPC_H_


#include "nwk/m2mb_ssl.h"
#include "m2mb_uart.h"
#include "m2mb_dbg.h"

/*-----------------------------------------------------------------------------------------------*/


#define M2MB_HTTPC_DEBUG_PRINT_ENABLE
#ifdef M2MB_HTTPC_DEBUG_PRINT_ENABLE
/* Initialize debug module in application to use debug print */
#define M2MB_HTTPC_DBG_PRINTF           m2mb_dbg_consol_print
#else
#define M2MB_HTTPC_DBG_PRINTF(...)
#endif


typedef enum M2MB_HTTPC_RESULT
{
  M2MB_HTTPC_SUCCESS                        = 0,
  M2MB_HTTPC_ERROR,                             
  M2MB_HTTPC_ERR_INVALID_PARAM,             
  M2MB_HTTPC_ERR_NO_MEMORY,                 
  M2MB_HTTPC_ERR_NO_RESOURCE,               
  M2MB_HTTPC_ERR_BUSY = 6,                  
  M2MB_HTTPC_ERR_NO_ENTRY,                  
  M2MB_HTTPC_ERR_NOT_SUPPORTED,             
  M2MB_HTTPC_ERR_TIMEOUT,                   
  M2MB_HTTPC_ERR_BOUNDS,                    
  M2MB_HTTPC_ERR_BAD_PAYLOAD,               
  M2MB_HTTPC_ERR_EXISTS,                    
  M2MB_HTTPC_CONTINUE,                          
}M2MB_HTTPC_RESULT_E;

typedef enum M2MB_HTTPC_METHODS {
        M2MB_HTTPC_METHOD_INVALID = 0,
        
        /*supported http client methods */
        M2MB_HTTPC_METHOD_GET_E = 1,
        M2MB_HTTPC_METHOD_HEAD_E,
        M2MB_HTTPC_METHOD_POST_E,
        M2MB_HTTPC_METHOD_PUT_E,
        M2MB_HTTPC_METHOD_DELETE_E,     
        M2MB_HTTPC_METHOD_CONNECT_E,
        M2MB_HTTPC_METHOD_PATCH_E,
        M2MB_HTTPC_METHOD_MAX_E
} M2MB_HTTPC_METHODS_E;


typedef enum M2MB_HTTPC_STATES
{
        M2MB_HTTPC_RX_ERROR_SERVER_CLOSED = -8,
        M2MB_HTTPC_RX_ERROR_RX_PROCESS = -7,
        M2MB_HTTPC_RX_ERROR_RX_HTTP_HEADER = -6,
        M2MB_HTTPC_RX_ERROR_INVALID_RESPONSECODE = -5,
        M2MB_HTTPC_RX_ERROR_CLIENT_TIMEOUT = -4,
        M2MB_HTTPC_RX_ERROR_NO_BUFFER = -3,
        M2MB_HTTPC_RX_CONNECTION_CLOSED = -2,
        M2MB_HTTPC_RX_ERROR_CONNECTION_CLOSED = -1,
        M2MB_HTTPC_RX_FINISHED = 0,
        M2MB_HTTPC_RX_MORE_DATA = 1,
} M2MB_HTTPC_STATES_E;


typedef struct M2MB_HTTPC_RESPONSE{
    UINT32    length;
    UINT32    resp_Code;
    UINT8 *    data;
} M2MB_HTTPC_RESPONSE_T;

#define HTTPCLIENT_MAX_URL_LENGTH 128

typedef VOID (*M2MB_HTTPC_CB_T)(VOID* arg, signed int state, VOID* value);

typedef struct M2MB_HTTPC_CTX{
        M2MB_SSL_CTXT_HANDLE ssl_handle;
        VOID *httpc_handle;
        M2MB_HTTPC_CB_T cb;
        VOID* arg;
        UINT32 timeout;
        M2MB_HTTPC_METHODS_E method;
        UINT8 url[HTTPCLIENT_MAX_URL_LENGTH + 1];    
        UINT32 max_body_len;
        UINT8  ischunked;    
        UINT8  chunksendInprogress;
}M2MB_HTTPC_CTX_T;

M2MB_HTTPC_RESULT_E m2mb_httpc_start();

M2MB_HTTPC_RESULT_E m2mb_httpc_stop();

VOID* m2mb_httpc_session_create(
        UINT32 timeout,
                M2MB_HTTPC_CB_T cb,
        VOID* cb_arg,
        UINT16 httpc_max_body_len,
                UINT16 httpc_max_Header_len,
                UINT16 httpc_Rx_Buffer_Size,
                VOID * m2mbSslCtx);


M2MB_HTTPC_RESULT_E m2mb_httpc_enable_http_response_header(VOID *handle, UINT16 enable);

M2MB_HTTPC_RESULT_E m2mb_httpc_session_abort(VOID *handle);

M2MB_HTTPC_RESULT_E m2mb_httpc_connect(VOID *handle, UINT8 *url, UINT16 port);

M2MB_HTTPC_RESULT_E m2mb_httpc_disconnect(VOID *handle);

M2MB_HTTPC_RESULT_E m2mb_httpc_request(VOID *handle, M2MB_HTTPC_METHODS_E method, UINT8 *url);

M2MB_HTTPC_RESULT_E m2mb_httpc_set_request_body(VOID *handle, UINT8 *body, UINT32 body_length, UINT32 total_length);

M2MB_HTTPC_RESULT_E m2mb_httpc_set_cgi_params(VOID *handle, UINT8 *arg, UINT8 *value);

M2MB_HTTPC_RESULT_E m2mb_httpc_set_header(VOID *handle,UINT8 *hdr_name, UINT8 *hdr_value);

M2MB_HTTPC_RESULT_E m2mb_httpc_clear_all_headers(VOID *handle);

M2MB_HTTPC_RESULT_E m2mb_httpc_session_getInfo(VOID *handle, M2MB_IP46_ADDR_T *ipv6, INT32 *socket);
        
M2MB_HTTPC_RESULT_E m2mb_httpc_send(VOID *handle, UINT8 isFirstPacket, 
                                                                UINT8 *body, UINT32 body_length, UINT32 total_length);

M2MB_HTTPC_RESULT_E m2mb_httpc_set_request(VOID *handle, M2MB_HTTPC_METHODS_E method, UINT8 *url);

/*-----------------------------------------------------------------------------------------------*/


#endif /* GEPS_INC_HTTP_CLIENT_M2MB_HTTPC_H_ */