httpc.h

浏览该文件的文档.

 
/*
 *  Copyright 2008-2013, Marvell International Ltd.
 *  All Rights Reserved.
 */
 
#ifndef _HTTPC_H_
#define _HTTPC_H_
 
#include <time.h>
#include "tal_time_service.h"
#include "tuya_hal_network.h"
 
typedef void * http_session_t;
 
/* Request methods */
typedef enum {
    HTTP_OPTIONS,       /* request to server for communication  options */
    HTTP_GET,       /* retrieve information */
    HTTP_HEAD,      /* get meta-info */
    HTTP_POST,      /* request to accept new sub-ordinate of resource */
    HTTP_PUT,       /* modify or create new resource referred to by URI */
    HTTP_DELETE,        /* delete the resource */
    HTTP_TRACE,     /* echo */
    HTTP_CONNECT,       /* do we need this  ? */
} http_method_t;
 
typedef enum {
    HTTP_VER_1_0,
    HTTP_VER_1_1,
} http_ver_t;
 
 
typedef enum  {
    HDR_ADD_DEFAULT_USER_AGENT  = 0x0001,
    /* Note: This flag is not necessary to set up persistent
     * connections in HTTP 1.1. However, if you want the server to
     * respond with persistent connection timeout values you may need
     * to add this flag. These timeout values are used to find out how
     * long a persistent connection will be kept alive by the
     * server. */
    HDR_ADD_CONN_KEEP_ALIVE     = 0x0002,
    HDR_ADD_CONN_CLOSE      = 0x0004,
    HDR_ADD_TYPE_CHUNKED            = 0x0008,
 
    // add content type
    HDR_ADD_CONTENT_TYPE_JSON       = 0x0010,
    HDR_ADD_CONTENT_TYPE_FORM_URLENCODE = 0x0020, // add by nzy 20150608
    HRD_ADD_DOWNLOAD_RANGE = 0x0040, /* add downlaod offset */
    HRD_ADD_HTTP_RAW = 0x0080, /* add downlaod offset */
 
} http_hdr_field_sel_t;
 
 
#define STANDARD_HDR_FLAGS          \
     (HDR_ADD_DEFAULT_USER_AGENT)
 
// user http head add callback
typedef void (*HTTP_HEAD_ADD_CB)(http_session_t session, VOID* data);
 
 
typedef unsigned int (*HTTP_CUSTOM_GET_CONTENT_LEN_CB)(VOID *pri_data);
typedef int (*HTTP_CUSTOM_BEFORE_READ_CONTENT_CB)(VOID *pri_data, unsigned int *p_malloc_buffer_size);
typedef int (*HTTP_CUSTOM_READ_CONTENT_CB)(unsigned char *p_buffer, int buf_size, VOID *pri_data);
typedef int (*HTTP_CUSTOM_AFTER_READ_CONTENT_CB)(VOID *pri_data);
 
typedef struct {
    HTTP_CUSTOM_GET_CONTENT_LEN_CB get_content_len_cb;
    HTTP_CUSTOM_BEFORE_READ_CONTENT_CB before_read_cb;
    HTTP_CUSTOM_READ_CONTENT_CB read_content_cb;
    HTTP_CUSTOM_AFTER_READ_CONTENT_CB after_read_cb;
    VOID *pri_data;
} http_custom_content_ctx_s;
 
 
void http_reset_session_state(http_session_t handle);
 
/*
 * Note 1: A resource is a part of the string immediately after the
 * hostname[:portno] part of the URL. In the URL,
 * [http://]hostname[:portno][/path/to/resource],
 * "/path/to/resource" part is called as a resource. It starts with the
 * character '/'.
 */
typedef struct {
    http_method_t type;
    const char *resource;
    unsigned char redirect_cnt;
    http_ver_t version;
    const char *content;
    int content_len;
    HTTP_HEAD_ADD_CB add_head_cb;
    VOID *add_head_data;
    unsigned int download_offset;
    unsigned int download_size;
 
    http_custom_content_ctx_s *p_custom_content_ctx;
} http_req_t;
 
typedef struct {
    const char *protocol;
    http_ver_t version;
    int status_code;
    const char *reason_phrase;
    const char *location;
    const char *server;
    const char *p_accept_ranges;
    time_t modify_time;
    const char *content_type;
    const char *content_encoding;
    bool_t keep_alive_ack;
    int keep_alive_timeout;
    int keep_alive_max;
    bool_t chunked;
    unsigned int content_length;
} http_resp_t;
 
typedef struct {
    char *name;
    char *value;
} http_header_pair_t;
 
typedef struct {
    const char *scheme;
    const char *hostname;
    unsigned portno;
    const char *resource;
} parsed_url_t;
 
enum wm_httpc_errno {
    WM_SUCCESS = 0,
    WM_E_INVAL,
    WM_FAIL,
    WM_E_IO,
    WM_E_AGAIN,
    WM_E_BADF,
    WM_E_NOMEM, // 6
    WM_E_HTTPC_TCP_CONNECT_FAIL,
    WM_E_HTTPC_TCP_TLS_CONNECT_FAIL,
    WM_E_HTTPC_FILE_NOT_FOUND,
    WM_E_HTTPC_BAD_REQUEST,//10
    WM_E_HTTPC_TLS_NOT_ENABLED,
    WM_E_HTTPC_SOCKET_ERROR,
    WM_E_HTTPC_SOCKET_SHUTDOWN,
 
    /* add by nzy 20150803 timeout */
    WM_E_HTTPC_SOCKET_TIMEOUT,//14
 
    /* dns parse failed */
    WM_E_HTTPC_DNS_PARSE_FAILED,
    /* socket creat failed */
    WM_E_HTTPC_SOCKET_CREAT_FAILED,
    /* parse url failed*/
    WM_E_HTTPC_URL_PARSE_FAILED,//17
};
 
 
/* Status codes */
#define HTTP_RESP_INFORMATIONAL(x) (x >=100 && < 200)
#define HTTP_RESP_SUCCESS(x) (x >= 200 && x < 300)
#define HTTP_RESP_REDIR(x) (x >= 300 && x < 400)
#define HTTP_RESP_CLIENT_ERR(x) (x >= 400 && x < 500)
#define HTTP_RESP_SERVER_ERR(x) (x >= 500 && x < 600)
 
/*
 * These macros are not of any use to the HTTP client itself. They are used
 * by the users of the HTTP client. This list may be extended if required
 */
#define HTTP_OK 200
#define HTTP_CREATED 201
#define HTTP_ACCEPTED  202
#define HTTP_FOUND 302
#define HTTP_NOT_MODIFIED 304
 
#define HTTP_BAD_REQUEST 400
#define HTTP_NOT_AUTH 401
#define HTTP_FORBIDDEN 403
#define HTTP_NOT_FOUND 404
 
/* max redirect count */
#define REDIRECT_CNT_MAX      5
/* default redirect count */
#define REDIRECT_CNT_DEFAULT  3
/* zero means disable http redirect */
#define REDIRECT_CNT_DISABLED 0
 
typedef enum {
    TLS_ENABLE = 0x01,
} http_open_flags_t;
 
int http_open_session(http_session_t *handle, const char *hostname, \
                      int flags, int retry_cnt);
 
int http_prepare_req(http_session_t handle, const http_req_t *req,
                     http_hdr_field_sel_t field_flags);
 
 
int http_add_header(http_session_t handle, const http_req_t *req,
                    const char *name, const char *value);
 
int http_send_request(http_session_t handle, const http_req_t * req, int send_content);
 
int http_get_response_hdr(http_session_t handle, http_resp_t ** resp);
 
int http_get_response_hdr_value(http_session_t handle,
                                const char *header_name, char **value);
int http_get_response_hdr_all(http_session_t handle, http_header_pair_t *arr,
                              int *count);
 
int http_read_content(http_session_t handle, void *buf, unsigned int max_len);
 
int http_parse_URL(const char *URL, char *tmp_buf, int tmp_buf_len,
                   parsed_url_t *parsed_url);
int http_lowlevel_read(http_session_t handle, void *buf, unsigned maxlen);
 
int http_lowlevel_write(http_session_t handle, const void *buf, unsigned len);
 
int http_write_standard(http_session_t handle, const void *buf, unsigned len);
 
int httpc_write_chunked(http_session_t handle, const char *data, int len);
 
void http_close_session(http_session_t *handle);
 
OPERATE_RET http_redirect_limit_set(IN UINT8_T cnt);
 
UINT8_T http_redirect_limit_get(void);
OPERATE_RET http_recv_timeout_set(IN UINT8_T timeout_s);
 
UINT8_T http_recv_timeout_get(void);
 
#endif /* _HTTPC_H_ */