httpclient.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_net_http_HTTPClient__include
#define ti_net_http_HTTPClient__include


#include <stdbool.h>

#include <ti/net/slnetsock.h>

/*
 * Bring in common definitions used by HTTP clients.  While this
 * violates the "only include headers you use" rule, these "common"
 * definitions were originally defined in this header file.  And not
 * providing them via this header file (now that they're really
 * defined in http.h) is a compatibility break for users who #include
 * <ti/net/http/httpclient.h> and expect the common definitions to be
 * provided.
 */
#include "http.h"

#ifdef __cplusplus
extern "C" {
#endif

#define HTTPClient_DOMAIN_BUFLEN                         (100)

#define HTTPClient_RES_HFIELD_BUFFER_SIZE                (300)

#define HTTPClient_MIN_USER_WORKSPACE_SIZE               (500)
#define HTTPClient_MAX_REDIRECTION_ATTEMPTS              (3)
#define HTTPClient_MAX_REQUEST_ATTEMPTS                  (2)
#define HTTPClient_MAX_RESPONSE_HEADER_FILEDS            (25)

#define HTTPClient_PORT                                  (80)
#define HTTPClient_SECURE_PORT                           (443)

/* HTTP response header fields */
#define HTTPClient_HFIELD_RES_AGE                        (0)  
#define HTTPClient_HFIELD_RES_ALLOW                      (1)  
#define HTTPClient_HFIELD_RES_CACHE_CONTROL              (2)  
#define HTTPClient_HFIELD_RES_CONNECTION                 (3)  
#define HTTPClient_HFIELD_RES_CONTENT_ENCODING           (4)  
#define HTTPClient_HFIELD_RES_CONTENT_LANGUAGE           (5)  
#define HTTPClient_HFIELD_RES_CONTENT_LENGTH             (6)  
#define HTTPClient_HFIELD_RES_CONTENT_LOCATION           (7)  
#define HTTPClient_HFIELD_RES_CONTENT_RANGE              (8)  
#define HTTPClient_HFIELD_RES_CONTENT_TYPE               (9)  
#define HTTPClient_HFIELD_RES_DATE                       (10) 
#define HTTPClient_HFIELD_RES_ETAG                       (11) 
#define HTTPClient_HFIELD_RES_EXPIRES                    (12) 
#define HTTPClient_HFIELD_RES_LAST_MODIFIED              (13) 
#define HTTPClient_HFIELD_RES_LOCATION                   (14) 
#define HTTPClient_HFIELD_RES_PROXY_AUTHENTICATE         (15) 
#define HTTPClient_HFIELD_RES_RETRY_AFTER                (16) 
#define HTTPClient_HFIELD_RES_SERVER                     (17) 
#define HTTPClient_HFIELD_RES_SET_COOKIE                 (18) 
#define HTTPClient_HFIELD_RES_TRAILER                    (19) 
#define HTTPClient_HFIELD_RES_TRANSFER_ENCODING          (20) 
#define HTTPClient_HFIELD_RES_UPGRADE                    (21) 
#define HTTPClient_HFIELD_RES_VARY                       (22) 
#define HTTPClient_HFIELD_RES_VIA                        (23) 
#define HTTPClient_HFIELD_RES_WWW_AUTHENTICATE           (24) 
#define HTTPClient_HFIELD_RES_WARNING                    (25) 
#define HTTPClient_REQUEST_HEADER_MASK                   (0x80000000)

/* HTTP request header fields */
#define HTTPClient_HFIELD_REQ_ACCEPT                     (26                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_ACCEPT_CHARSET             (27                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_ACCEPT_ENCODING            (28                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_ACCEPT_LANGUAGE            (29                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_ALLOW                      (HTTPClient_HFIELD_RES_ALLOW               | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_AUTHORIZATION              (30                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_CACHE_CONTROL              (HTTPClient_HFIELD_RES_CACHE_CONTROL       | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_CONNECTION                 (HTTPClient_HFIELD_RES_CONNECTION          | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_CONTENT_ENCODING           (HTTPClient_HFIELD_RES_CONTENT_ENCODING    | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_CONTENT_LANGUAGE           (HTTPClient_HFIELD_RES_CONTENT_LANGUAGE    | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_CONTENT_LOCATION           (HTTPClient_HFIELD_RES_CONTENT_LOCATION    | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_CONTENT_TYPE               (HTTPClient_HFIELD_RES_CONTENT_TYPE        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_COOKIE                     (31                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_DATE                       (HTTPClient_HFIELD_RES_DATE                | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_EXPECT                     (32                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_FORWARDED                  (33                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_FROM                       (34                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_HOST                       (35                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_IF_MATCH                   (36                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_IF_MODIFIED_SINCE          (37                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_IF_NONE_MATCH              (38                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_IF_RANGE                   (39                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_IF_UNMODIFIED_SINCE        (40                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_ORIGIN                     (41                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_PROXY_AUTHORIZATION        (42                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_RANGE                      (43                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_TE                         (44                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_TRANSFER_ENCODING          (HTTPClient_HFIELD_RES_TRANSFER_ENCODING   | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_UPGRADE                    (HTTPClient_HFIELD_RES_UPGRADE             | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_USER_AGENT                 (45                                        | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_VIA                        (HTTPClient_HFIELD_RES_VIA                 | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_HFIELD_REQ_WARNING                    (HTTPClient_HFIELD_RES_WARNING             | HTTPClient_REQUEST_HEADER_MASK)

#define HTTPClient_MAX_NUMBER_OF_HEADER_FIELDS           (46)

/* SetOpt options */
#define HTTPClient_REDIRECT_FEATURE                      (48)

#define HTTPClient_RESPONSE_FILTER_CLEAR                 (49)

#define HTTPClient_REDIRECT_TLS_DOWNGRADE                (50)

#define HTTPClient_AUTHENTICATE_SERVER_CALLBACK          (51)

/* HTTP Client Error Codes */

#define HTTPClient_ESENDBUFSMALL                         (-3001)

#define HTTPClient_EGETOPTBUFSMALL                       (-3002)

#define HTTPClient_ERESPONSEINVALID                      (-3003)

#define HTTPClient_EINPROGRESS                           (-3004)

#define HTTPClient_EDOMAINBUFSMALL                       (-3005)

#define HTTPClient_ECBALLOCATIONFAILED                   (-3006)

#define HTTPClient_EBODYBUFSMALL                         (-3008)

#define HTTPClient_ENULLPOINTER                          (-3009)

#define HTTPClient_EREQUESTHEADERALLOCFAILED             (-3010)

#define HTTPClient_EREQHEADERNOTFOUND                    (-3011)

#define HTTPClient_EHOSTNOTFOUND                         (-3012)

#define HTTPClient_ECLIENTALREADYCONNECTED               (-3013)

#define HTTPClient_ERESPONSEISNOTREDIRECTABLE            (-3014)

#define HTTPClient_ESENDERROR                            (-3015)

#define HTTPClient_EREDIRECTLOCATIONFAIL                 (-3016)

#define HTTPClient_ETLSDOWNGRADEISFORBIDDEN              (-3017)

#define HTTPClient_EWRONGAPIPARAMETER                    (-3018)

#define HTTPClient_EHOSTHEADERALREADYEXIST               (-3019)

#define HTTPClient_ENOCONNECTION                         (-3020)

#define HTTPClient_ENOTABSOLUTEURI                       (-3021)

#define HTTPClient_ECANTCREATESECATTRIB                  (-3022)

#define HTTPClient_EINTERNAL                             (-3023)

#define HTTPClient_EGETCUSOMHEADERBUFSMALL               (-3024)

#define HTTPClient_ENOHEADERNAMEDASINSERTED              (-3025)

/* HTTPClient_connect flags */
#define HTTPClient_IGNORE_PROXY                (0x01)

#define HTTPClient_HOST_EXIST                  (0x02)

/* HTTPClient_setHeader flags */
#define HTTPClient_HFIELD_NOT_PERSISTENT       (0x01)

#define HTTPClient_HFIELD_PERSISTENT           (0x02)

/* HTTPClient_setHeaderByName 'option' flag */
#define HTTPClient_CUSTOM_RESPONSE_HEADER      (0x01)


/* HTTPClient_sendRequest flags */
#define HTTPClient_CHUNK_START                 (0x01)

#define HTTPClient_CHUNK_END                   (0x02)

#define HTTPClient_DROP_BODY                   (0x04)


/* HTTP Request Methods */
extern const char *HTTP_METHOD_GET;
extern const char *HTTP_METHOD_POST;
extern const char *HTTP_METHOD_HEAD;
extern const char *HTTP_METHOD_OPTIONS;
extern const char *HTTP_METHOD_PUT;
extern const char *HTTP_METHOD_DELETE;
extern const char *HTTP_METHOD_CONNECT;

/* structure user need to use for security */
typedef struct HTTPClient_extSecParams
{
    const char *privateKey; /* Private key */
    const char *clientCert; /* Client certificate */
    const char *rootCa; /* Root CA */
}HTTPClient_extSecParams;

typedef int16_t (*HTTPClient_authenticationCallback)(const char *serverAuthBuff, uint32_t serverAuthLen, char *clientAuthBuff, uint32_t *clientAuthLen);

typedef void *HTTPClient_Handle;

HTTPClient_Handle HTTPClient_create(int16_t * status, void *params);

int16_t HTTPClient_destroy(HTTPClient_Handle client);

int16_t HTTPClient_connect2(HTTPClient_Handle client, const char *hostName, SlNetSockSecAttrib_t *secAttribs, uint32_t flags, int16_t *secureRetVal);

int16_t HTTPClient_connect(HTTPClient_Handle client, const char *hostName, HTTPClient_extSecParams *exSecParams, uint32_t flags);

int16_t HTTPClient_disconnect(HTTPClient_Handle client);


int16_t HTTPClient_sendRequest(HTTPClient_Handle client, const char *method,const char *requestURI, const char *body, uint32_t bodyLen, uint32_t flags);

int16_t HTTPClient_readResponseBody(HTTPClient_Handle client, char *body, uint32_t bodyLen, bool *moreDataFlag);

int16_t HTTPClient_setHeader(HTTPClient_Handle client, uint32_t option, void *value, uint32_t len, uint32_t flags);

int16_t HTTPClient_setHeaderByName(HTTPClient_Handle client, uint32_t option, const char *name, void *value, uint32_t len, uint32_t flags);

int16_t HTTPClient_getHeader(HTTPClient_Handle client, uint32_t option, void *value, uint32_t *len, uint32_t flags);

int16_t HTTPClient_getHeaderByName(HTTPClient_Handle client, uint32_t option, const char* name, void *value, uint32_t *len ,uint32_t flags);
int16_t HTTPClient_setOpt(HTTPClient_Handle client, uint32_t option, void *value, uint32_t len, uint32_t flags);

int16_t HTTPClient_getOpt(HTTPClient_Handle client, uint32_t option, void *value, uint32_t *len ,uint32_t flags);

void HTTPClient_setProxy(const SlNetSock_Addr_t *addr);

#ifdef __cplusplus
}
#endif

#endif