WE310F5  39.00.000
m2mb_httpc.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
45 #ifndef M2MB_INC_HTTP_CLIENT_M2MB_HTTPC_H_
46 #define M2MB_INC_HTTP_CLIENT_M2MB_HTTPC_H_
47 
68 /*-----------------------------------------------------------------------------------------------*/
69 
70 
75 /*-----------------------------------------------------------------------------------------------*/
76 /* Global declarations ==========================================================================*/
77 #define M2MB_HTTPCLIENT_MAX_URL_LENGTH 1024 //was 256
78 #define M2MB_HTTPCLIENT_MAX_HOST_LENGTH 64
79 
82 typedef HANDLE M2MB_HTTPC_CTXT_HANDLE;
86 typedef enum M2MB_HTTPC_METHODS {
87  M2MB_HTTPC_METHOD_INVALID = 0,
88  M2MB_HTTPC_METHOD_GET = 1,
89  M2MB_HTTPC_METHOD_HEAD,
90  M2MB_HTTPC_METHOD_POST,
91  M2MB_HTTPC_METHOD_PUT,
92  M2MB_HTTPC_METHOD_MAX
93 } M2MB_HTTPC_METHODS_E;
94 
95 
99 typedef enum M2MB_HTTPC_STATES
100 {
101  M2MB_HTTPC_RX_ERROR_SERVER_CLOSED = -8,
103  M2MB_HTTPC_RX_ERROR_RX_PROCESS = -7,
105  M2MB_HTTPC_RX_ERROR_RX_HTTP_HEADER = -6,
107  M2MB_HTTPC_RX_ERROR_INVALID_RESPONSECODE = -5,
109  M2MB_HTTPC_RX_ERROR_CLIENT_TIMEOUT = -4,
111  M2MB_HTTPC_RX_ERROR_NO_BUFFER = -3,
113  M2MB_HTTPC_RX_CONNECTION_CLOSED = -2,
115  M2MB_HTTPC_RX_ERROR_CONNECTION_CLOSED = -1,
117  M2MB_HTTPC_RX_FINISHED = 0,
119  M2MB_HTTPC_RX_MORE_DATA = 1,
121 } M2MB_HTTPC_STATES_E;
122 
123 
127 typedef enum M2MB_HTTPC_CONF_ID
128 {
129  M2MB_HTTPC_CONF_INVALID = 0,
131  M2MB_HTTPC_CONF_SET_HEADER,
133  M2MB_HTTPC_CONF_SET_CGI_PARAMS,
135  M2MB_HTTPC_CONF_SET_ENABLE_RESP_HEADER,
137  M2MB_HTTPC_CONF_SET_CLEAR_ALL_HEADER,
139  M2MB_HTTPC_CONF_SET_TIMEOUT,
141  M2MB_HTTPC_CONF_GET_SERVER_IP,
143  M2MB_HTTPC_CONF_GET_SOCK_ID,
146 }M2MB_HTTPC_CONF_ID_E;
147 
151 typedef struct M2MB_HTTPC_RESPONSE{
152  UINT32 length;
154  UINT32 resp_Code;
156  UINT8 * data;
158 } M2MB_HTTPC_RESPONSE_T;
159 
213 typedef VOID (*M2MB_HTTPC_CB_T)(
214  VOID* arg,
215  M2MB_HTTPC_STATES_E state,
216  M2MB_HTTPC_RESPONSE_T* value);
217 
223 typedef union M2MB_HTTPC_CONF_PARAMS{
224  struct param{
225  UINT8 *header_name;
226  UINT8 *header_val;
227  }param;
229  UINT8 enable_rsp_header;
231  M2MB_IP46_ADDR_T IP46_addr;
233  INT32 sockId;
235  UINT32 timeout;
236 }M2MB_HTTPC_CONF_PARAMS_T;
237 
245 typedef struct M2MB_HTTPC_OPEN_PARAMS
246 {
247  UINT32 timeout;
248  UINT16 httpc_max_body_len;
249  UINT16 httpc_max_Header_len;
250  UINT16 httpc_rx_buf_len;
252  VOID * m2mbSslCtx;
253  M2MB_HTTPC_CB_T cb;
254  VOID* cb_arg;
255 }M2MB_HTTPC_OPEN_PARAMS_T;
256 
257 
258 
259 /*-----------------------------------------------------------------------------------------------*/
313 /*-----------------------------------------------------------------------------------------------*/
314 
315 M2MB_STATUS_T m2mb_httpc_open(
316  HANDLE *hndl,
317  M2MB_HTTPC_OPEN_PARAMS_T* params);
318 
319 /*-----------------------------------------------------------------------------------------------*/
424 /*-----------------------------------------------------------------------------------------------*/
425 
426 M2MB_STATUS_T m2mb_httpc_set_cfg(
427  HANDLE handle,
428  M2MB_HTTPC_CONF_ID_E conf_id,
429  M2MB_HTTPC_CONF_PARAMS_T * conf_params);
430 
431 /*-----------------------------------------------------------------------------------------------*/
531 /*-----------------------------------------------------------------------------------------------*/
532 
533 M2MB_STATUS_T m2mb_httpc_get_cfg(
534  HANDLE handle,
535  M2MB_HTTPC_CONF_ID_E conf_id,
536  M2MB_HTTPC_CONF_PARAMS_T * conf_params);
537 
538 /*-----------------------------------------------------------------------------------------------*/
623 /*-----------------------------------------------------------------------------------------------*/
624 
625 M2MB_STATUS_T m2mb_httpc_connect(
626  HANDLE handle,
627  UINT8 *url,
628  UINT16 port);
629 
630 /*-----------------------------------------------------------------------------------------------*/
724 /*-----------------------------------------------------------------------------------------------*/
725 
726 M2MB_STATUS_T m2mb_httpc_set_request(
727  VOID *handle,
728  M2MB_HTTPC_METHODS_E method,
729  UINT8 *url);
730 /*-----------------------------------------------------------------------------------------------*/
948 /*-----------------------------------------------------------------------------------------------*/
949 M2MB_STATUS_T m2mb_httpc_send(
950  VOID *handle,
951  UINT8 isFirstPacket,
952  UINT8 *body,
953  UINT32 body_length,
954  UINT32 total_length);
955 
956 /*-----------------------------------------------------------------------------------------------*/
1052 /*-----------------------------------------------------------------------------------------------*/
1053 M2MB_STATUS_T m2mb_httpc_close(
1054  HANDLE handle);
1055 
1056 
1060 /*-----------------------------------------------------------------------------------------------*/
1061 
1062 
1063 #endif /* M2MB_INC_HTTP_CLIENT_M2MB_HTTPC_H_ */
m2mb_httpc_close
M2MB_STATUS_T m2mb_httpc_close(HANDLE handle)
closes an HTTP client session.
m2mb_httpc_open
M2MB_STATUS_T m2mb_httpc_open(HANDLE *hndl, M2MB_HTTPC_OPEN_PARAMS_T *params)
create http client context
m2mb_httpc_set_request
M2MB_STATUS_T m2mb_httpc_set_request(VOID *handle, M2MB_HTTPC_METHODS_E method, UINT8 *url)
Set the http request.
M2MB_IP46_ADDR
Socket IPv4/IPv6 Internet address union.
Definition: m2mb_socket.h:386
M2MB_HTTPC_STATES
M2MB_HTTPC_STATES
HTTP client callback state.
Definition: m2mb_httpc.h:99
M2MB_HTTPC_METHODS
M2MB_HTTPC_METHODS
supported http request method for use with m2mb_httpc_request.
Definition: m2mb_httpc.h:86
M2MB_HTTPC_METHODS_E
enum M2MB_HTTPC_METHODS M2MB_HTTPC_METHODS_E
supported http request method for use with m2mb_httpc_request.
UINT8
unsigned char UINT8
Definition: m2mb_types.h:86
M2MB_HTTPC_CONF_PARAMS
HTTP client configuration params structure for use in m2mb_http_set_cfg and m2mb_httpc_get_cfg APIs...
Definition: m2mb_httpc.h:223
M2MB_HTTPC_CB_T
VOID(* M2MB_HTTPC_CB_T)(VOID *arg, M2MB_HTTPC_STATES_E state, M2MB_HTTPC_RESPONSE_T *value)
User registered callback for returning response message.
Definition: m2mb_httpc.h:213
M2MB_STATUS_T
INT32 M2MB_STATUS_T
Definition: m2mb_status.h:97
m2mb_httpc_connect
M2MB_STATUS_T m2mb_httpc_connect(HANDLE handle, UINT8 *url, UINT16 port)
Connects to an HTTP server in Blocking mode.
m2mb_httpc_get_cfg
M2MB_STATUS_T m2mb_httpc_get_cfg(HANDLE handle, M2MB_HTTPC_CONF_ID_E conf_id, M2MB_HTTPC_CONF_PARAMS_T *conf_params)
get the http client session information
UINT16
unsigned short UINT16
Definition: m2mb_types.h:87
M2MB_HTTPC_CTXT_HANDLE
HANDLE M2MB_HTTPC_CTXT_HANDLE
HTTPC context handle. This is obtained from m2mb_httpc_open API and then used in subsequent HTTPC A...
Definition: m2mb_httpc.h:82
M2MB_HTTPC_OPEN_PARAMS
HTTPC parameters required to open a client connection.
Definition: m2mb_httpc.h:245
m2mb_httpc_set_cfg
M2MB_STATUS_T m2mb_httpc_set_cfg(HANDLE handle, M2MB_HTTPC_CONF_ID_E conf_id, M2MB_HTTPC_CONF_PARAMS_T *conf_params)
update the http client session configurations
M2MB_HTTPC_CONF_PARAMS_T
union M2MB_HTTPC_CONF_PARAMS M2MB_HTTPC_CONF_PARAMS_T
HTTP client configuration params structure for use in m2mb_http_set_cfg and m2mb_httpc_get_cfg APIs...
M2MB_HTTPC_CONF_PARAMS::param
struct M2MB_HTTPC_CONF_PARAMS::param param
VOID
void VOID
Definition: m2mb_types.h:74
M2MB_HTTPC_RESPONSE_T
struct M2MB_HTTPC_RESPONSE M2MB_HTTPC_RESPONSE_T
HTTP client response for use in user callback.
M2MB_HTTPC_OPEN_PARAMS_T
struct M2MB_HTTPC_OPEN_PARAMS M2MB_HTTPC_OPEN_PARAMS_T
HTTPC parameters required to open a client connection.
UINT32
unsigned long int UINT32
Definition: m2mb_types.h:88
M2MB_HTTPC_CONF_ID_E
enum M2MB_HTTPC_CONF_ID M2MB_HTTPC_CONF_ID_E
HTTP client confg id for use in m2mb_http_set_cfg and m2mb_httpc_get_cfg APIs.
M2MB_HTTPC_CONF_ID
M2MB_HTTPC_CONF_ID
HTTP client confg id for use in m2mb_http_set_cfg and m2mb_httpc_get_cfg APIs.
Definition: m2mb_httpc.h:127
INT32
signed int INT32
Definition: m2mb_types.h:82
m2mb_httpc_send
M2MB_STATUS_T m2mb_httpc_send(VOID *handle, UINT8 isFirstPacket, UINT8 *body, UINT32 body_length, UINT32 total_length)
Send HTTP information from the http client session.
HANDLE
void * HANDLE
Definition: m2mb_types.h:98
M2MB_HTTPC_STATES_E
enum M2MB_HTTPC_STATES M2MB_HTTPC_STATES_E
HTTP client callback state.
M2MB_HTTPC_CONF_PARAMS::IP46_addr
M2MB_IP46_ADDR_T IP46_addr
Definition: m2mb_httpc.h:231
M2MB_HTTPC_OPEN_PARAMS::cb
M2MB_HTTPC_CB_T cb
Definition: m2mb_httpc.h:253
M2MB_HTTPC_RESPONSE
HTTP client response for use in user callback.
Definition: m2mb_httpc.h:151