httpcli.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2017, 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_HTTPCli__include
#define ti_net_http_HTTPCli__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include <ti/net/ssock.h>
#include <ti/net/tls.h>
#include <ti/net/http/httpstd.h>

#ifndef HTTPCli_BUF_LEN
#define HTTPCli_BUF_LEN 128
#endif

#define HTTPCli_RECV_BUFLEN 32

#define HTTPCli_ESOCKETFAIL        (-101)

#define HTTPCli_ECONNECTFAIL       (-102)

#define HTTPCli_ESENDFAIL          (-103)

#define HTTPCli_ERECVFAIL          (-104)

#define HTTPCli_ETLSFAIL           (-105)

#define HTTPCli_EHOSTNAME          (-106)

#define HTTPCli_ESENDBUFSMALL      (-107)

#define HTTPCli_ERECVBUFSMALL      (-108)

#define HTTPCli_EASYNCMODE         (-109)

#define HTTPCli_ETHREADFAIL        (-110)

#define HTTPCli_EPROXYTUNNELFAIL   (-111)

#define HTTPCli_ERESPONSEINVALID   (-112)

#define HTTPCli_ECONTENTLENLARGE   (-114)

#define HTTPCli_EREDIRECTURILONG   (-115)

#define HTTPCli_ECONTENTTYPELONG   (-116)

#define HTTPCli_ENOCONTENTCALLBACK (-117)

#define HTTPCli_ENOTCHUNKDATA      (-118)

#define HTTPCli_EINPROGRESS        (-119)

#define HTTPCli_EINTERNALBUFSMALL  (-120)

#define HTTPCli_ESETNOTIFYFAIL     (-121)

#define HTTPCli_EURILENLONG        (-122)

#define HTTPCli_EHOSTFIELDNOTFOUND (-123)

#ifdef ti_net_http_HTTPCli__deprecated

/* Standard ports */
#define HTTP_PORT HTTPStd_PORT
#define HTTPS_PORT HTTPStd_SECURE_PORT

/* HTTP Status Codes */
#define HTTP_CONTINUE                      HTTPStd_CONTINUE
#define HTTP_SWITCHING_PROTOCOLS           HTTPStd_SWITCHING_PROTOCOLS
#define HTTP_OK                            HTTPStd_OK
#define HTTP_CREATED                       HTTPStd_CREATED
#define HTTP_ACCEPTED                      HTTPStd_ACCEPTED
#define HTTP_NON_AUTHORITATIVE_INFORMATION HTTPStd_NON_AUTHORITATIVE_INFORMATION
#define HTTP_NO_CONTENT                    HTTPStd_NO_CONTENT
#define HTTP_RESET_CONTENT                 HTTPStd_RESET_CONTENT
#define HTTP_PARTIAL_CONTENT               HTTPStd_PARTIAL_CONTENT
#define HTTP_MULTIPLE_CHOICES              HTTPStd_MULTIPLE_CHOICES
#define HTTP_MOVED_PERMANENTLY             HTTPStd_MOVED_PERMANENTLY
#define HTTP_FOUND                         HTTPStd_FOUND
#define HTTP_SEE_OTHER                     HTTPStd_SEE_OTHER
#define HTTP_NOT_MODIFIED                  HTTPStd_NOT_MODIFIED
#define HTTP_USE_PROXY                     HTTPStd_USE_PROXY
#define HTTP_TEMPORARY_REDIRECT            HTTPStd_TEMPORARY_REDIRECT
#define HTTP_BAD_REQUEST                   HTTPStd_BAD_REQUEST
#define HTTP_UNAUTHORIZED                  HTTPStd_UNAUTHORIZED
#define HTTP_PAYMENT_REQUIRED              HTTPStd_PAYMENT_REQUIRED
#define HTTP_FORBIDDEN                     HTTPStd_FORBIDDEN
#define HTTP_NOT_FOUND                     HTTPStd_NOT_FOUND
#define HTTP_METHOD_NOT_ALLOWED            HTTPStd_METHOD_NOT_ALLOWED
#define HTTP_NOT_ACCEPTABLE                HTTPStd_NOT_ACCEPTABLE
#define HTTP_PROXY_AUTHENTICATION_REQUIRED HTTPStd_PROXY_AUTHENTICATION_REQUIRED
#define HTTP_REQUEST_TIMEOUT               HTTPStd_REQUEST_TIMEOUT
#define HTTP_CONFLICT                      HTTPStd_CONFLICT
#define HTTP_GONE                          HTTPStd_GONE
#define HTTP_LENGTH_REQUIRED               HTTPStd_LENGTH_REQUIRED
#define HTTP_PRECONDITION_FAILED           HTTPStd_PRECONDITION_FAILED
#define HTTP_REQUEST_ENTITY_TOO_LARGE      HTTPStd_REQUEST_ENTITY_TOO_LARGE
#define HTTP_REQUEST_URI_TOO_LONG          HTTPStd_REQUEST_URI_TOO_LONG
#define HTTP_UNSUPPORTED_MEDIA_TYPE        HTTPStd_UNSUPPORTED_MEDIA_TYPE
#define HTTP_REQUESTED_RANGE_NOT_SATISFAIABLE \
        HTTPStd_REQUESTED_RANGE_NOT_SATISFAIABLE
#define HTTP_EXPECTATION_FAILED            HTTPStd_EXPECTATION_FAILED
#define HTTP_INTERNAL_SERVER_ERROR         HTTPStd_INTERNAL_SERVER_ERROR
#define HTTP_NOT_IMPLEMENTED               HTTPStd_NOT_IMPLEMENTED
#define HTTP_BAD_GATEWAY                   HTTPStd_BAD_GATEWAY
#define HTTP_SERVICE_UNAVAILABLE           HTTPStd_SERVICE_UNAVAILABLE
#define HTTP_GATEWAY_TIMEOUT               HTTPStd_GATEWAY_TIMEOUT
#define HTTP_HTTP_VERSION_NOT_SUPPORTED    HTTPStd_HTTP_VERSION_NOT_SUPPORTED

/* HTTP methods */
#define HTTPCli_METHOD_GET      HTTPStd_GET
#define HTTPCli_METHOD_POST     HTTPStd_POST
#define HTTPCli_METHOD_HEAD     HTTPStd_HEAD
#define HTTPCli_METHOD_OPTIONS  HTTPStd_OPTIONS
#define HTTPCli_METHOD_PUT      HTTPStd_PUT
#define HTTPCli_METHOD_DELETE   HTTPStd_DELETE
#define HTTPCli_METHOD_CONNECT  HTTPStd_CONNECT

/* HTTP Request Field Name */
#define HTTPCli_FIELD_NAME_ACCEPT  HTTPStd_FIELD_NAME_ACCEPT
#define HTTPCli_FIELD_NAME_ACCEPT_CHARSET  HTTPStd_FIELD_NAME_ACCEPT_CHARSET
#define HTTPCli_FIELD_NAME_ACCEPT_ENCODING  HTTPStd_FIELD_NAME_ACCEPT_ENCODING
#define HTTPCli_FIELD_NAME_ACCEPT_LANGUAGE  HTTPStd_FIELD_NAME_ACCEPT_LANGUAGE
#define HTTPCli_FIELD_NAME_ACCEPT_RANGES  HTTPStd_FIELD_NAME_ACCEPT_RANGES
#define HTTPCli_FIELD_NAME_AGE  HTTPStd_FIELD_NAME_AGE
#define HTTPCli_FIELD_NAME_ALLOW  HTTPStd_FIELD_NAME_ALLOW
#define HTTPCli_FIELD_NAME_AUTHORIZATION  HTTPStd_FIELD_NAME_AUTHORIZATION
#define HTTPCli_FIELD_NAME_CACHE_CONTROL  HTTPStd_FIELD_NAME_CACHE_CONTROL
#define HTTPCli_FIELD_NAME_CONNECTION  HTTPStd_FIELD_NAME_CONNECTION
#define HTTPCli_FIELD_NAME_CONTENT_ENCODING  HTTPStd_FIELD_NAME_CONTENT_ENCODING
#define HTTPCli_FIELD_NAME_CONTENT_LANGUAGE  HTTPStd_FIELD_NAME_CONTENT_LANGUAGE
#define HTTPCli_FIELD_NAME_CONTENT_LENGTH  HTTPStd_FIELD_NAME_CONTENT_LENGTH
#define HTTPCli_FIELD_NAME_CONTENT_LOCATION  HTTPStd_FIELD_NAME_CONTENT_LOCATION
#define HTTPCli_FIELD_NAME_CONTENT_MD5  HTTPStd_FIELD_NAME_CONTENT_MD5
#define HTTPCli_FIELD_NAME_CONTENT_RANGE  HTTPStd_FIELD_NAME_CONTENT_RANGE
#define HTTPCli_FIELD_NAME_CONTENT_TYPE  HTTPStd_FIELD_NAME_CONTENT_TYPE
#define HTTPCli_FIELD_NAME_COOKIE  HTTPStd_FIELD_NAME_COOKIE
#define HTTPCli_FIELD_NAME_DATE  HTTPStd_FIELD_NAME_DATE
#define HTTPCli_FIELD_NAME_ETAG  HTTPStd_FIELD_NAME_ETAG
#define HTTPCli_FIELD_NAME_EXPECT  HTTPStd_FIELD_NAME_EXPECT
#define HTTPCli_FIELD_NAME_EXPIRES  HTTPStd_FIELD_NAME_EXPIRES
#define HTTPCli_FIELD_NAME_FROM  HTTPStd_FIELD_NAME_FROM
#define HTTPCli_FIELD_NAME_HOST  HTTPStd_FIELD_NAME_HOST
#define HTTPCli_FIELD_NAME_IF_MATCH  HTTPStd_FIELD_NAME_IF_MATCH
#define HTTPCli_FIELD_NAME_IF_MODIFIED_SINCE  \
        HTTPStd_FIELD_NAME_IF_MODIFIED_SINCE
#define HTTPCli_FIELD_NAME_IF_NONE_MATCH  HTTPStd_FIELD_NAME_IF_NONE_MATCH
#define HTTPCli_FIELD_NAME_IF_RANGE  HTTPStd_FIELD_NAME_IF_RANGE
#define HTTPCli_FIELD_NAME_IF_UNMODIFIED_SINCE  \
        HTTPStd_FIELD_NAME_IF_UNMODIFIED_SINCE
#define HTTPCli_FIELD_NAME_LAST_MODIFIED  HTTPStd_FIELD_NAME_LAST_MODIFIED
#define HTTPCli_FIELD_NAME_LOCATION  HTTPStd_FIELD_NAME_LOCATION
#define HTTPCli_FIELD_NAME_MAX_FORWARDS  HTTPStd_FIELD_NAME_MAX_FORWARDS
#define HTTPCli_FIELD_NAME_ORIGIN  HTTPStd_FIELD_NAME_ORIGIN
#define HTTPCli_FIELD_NAME_PRAGMA  HTTPStd_FIELD_NAME_PRAGMA
#define HTTPCli_FIELD_NAME_PROXY_AUTHENTICATE  \
        HTTPStd_FIELD_NAME_PROXY_AUTHENTICATE
#define HTTPCli_FIELD_NAME_PROXY_AUTHORIZATION  \
        HTTPStd_FIELD_NAME_PROXY_AUTHORIZATION
#define HTTPCli_FIELD_NAME_RANGE  HTTPStd_FIELD_NAME_RANGE
#define HTTPCli_FIELD_NAME_REFERER  HTTPStd_FIELD_NAME_REFERER
#define HTTPCli_FIELD_NAME_RETRY_AFTER  HTTPStd_FIELD_NAME_RETRY_AFTER
#define HTTPCli_FIELD_NAME_SERVER  HTTPStd_FIELD_NAME_SERVER
#define HTTPCli_FIELD_NAME_TE  HTTPStd_FIELD_NAME_TE
#define HTTPCli_FIELD_NAME_TRAILER  HTTPStd_FIELD_NAME_TRAILER
#define HTTPCli_FIELD_NAME_TRANSFER_ENCODING  \
        HTTPStd_FIELD_NAME_TRANSFER_ENCODING
#define HTTPCli_FIELD_NAME_UPGRADE  HTTPStd_FIELD_NAME_UPGRADE
#define HTTPCli_FIELD_NAME_USER_AGENT  HTTPStd_FIELD_NAME_USER_AGENT
#define HTTPCli_FIELD_NAME_VARY  HTTPStd_FIELD_NAME_VARY
#define HTTPCli_FIELD_NAME_VIA  HTTPStd_FIELD_NAME_VIA
#define HTTPCli_FIELD_NAME_WWW_AUTHENTICATE  HTTPStd_FIELD_NAME_WWW_AUTHENTICATE
#define HTTPCli_FIELD_NAME_WARNING  HTTPStd_FIELD_NAME_WARNING
#define HTTPCli_FIELD_NAME_X_FORWARDED_FOR  HTTPStd_FIELD_NAME_X_FORWARDED_FOR

#endif

#define HTTPCli_TYPE_TLS   (0x02)
#define HTTPCli_TYPE_IPV6  (0x04)

#define HTTPCli_FIELD_ID_DUMMY   (-11)
#define HTTPCli_FIELD_ID_END     (-12)

typedef struct HTTPCli_Field {
    const char *name;      
    const char *value;     
} HTTPCli_Field;

typedef void (*HTTPCli_StatusCallback)(void *cli, int status);

typedef struct HTTPCli_StatusHandler {
    HTTPCli_StatusCallback  handle1xx;  
    HTTPCli_StatusCallback  handle2xx;  
    HTTPCli_StatusCallback  handle4xx;  
} HTTPCli_StatusHandler;

typedef int (*HTTPCli_ContentCallback)(void *cli, int status, char *body,
        int len, bool moreFlag);

typedef struct HTTPCli_ContentHandler {
    char *contentType;               
    HTTPCli_ContentCallback handle;  
} HTTPCli_ContentHandler;

typedef void (*HTTPCli_RedirectCallback)(void *cli, int status, char *uri);

typedef void (*HTTPCli_Notify)(long skt, void *cli);
typedef struct HTTPCli_Struct {
    char **respFields;
    int sockerr;
    unsigned int state;
    unsigned long clen;
    Ssock_Struct ssock;
    HTTPCli_Field *fields;

    char buf[HTTPCli_BUF_LEN]; 
    unsigned int buflen;
    char *bufptr;

    TLS_Handle tls;
#ifndef HTTPCli_LIBTYPE_MIN
    HTTPCli_StatusHandler *shandle;
    HTTPCli_ContentHandler *chandle;
    HTTPCli_RedirectCallback rhandle;
#ifndef __linux__
    unsigned int stackSize;
    unsigned int priority;
#endif
#endif

} HTTPCli_Struct;

typedef struct HTTPCli_Params {

    TLS_Handle tls;
#ifndef HTTPCli_LIBTYPE_MIN
    HTTPCli_StatusHandler *shandle;
    HTTPCli_ContentHandler *chandle;
    HTTPCli_RedirectCallback rhandle;
#ifndef __linux__
    unsigned int stackSize; 
    unsigned int priority;  
#endif
#endif

#ifdef NET_SLP
    HTTPCli_Notify rnotify;   
    HTTPCli_Notify wnotify;   
    HTTPCli_Notify enotify;   
#endif

#ifndef NET_SLP
    int timeout;
#endif

} HTTPCli_Params;

typedef HTTPCli_Struct* HTTPCli_Handle;

extern void HTTPCli_Params_init(HTTPCli_Params *params);

extern int HTTPCli_initSockAddr(struct sockaddr *addr, const char *uri,
        int flags);

extern void HTTPCli_construct(HTTPCli_Struct *cli);

extern HTTPCli_Handle HTTPCli_create();

extern int HTTPCli_connect(HTTPCli_Handle cli, const struct sockaddr *addr,
        int flags, const HTTPCli_Params *params);

extern void HTTPCli_delete(HTTPCli_Handle *cli);

extern void HTTPCli_destruct(HTTPCli_Struct *cli);

extern void HTTPCli_disconnect(HTTPCli_Handle cli);

extern HTTPCli_Field *HTTPCli_setRequestFields(HTTPCli_Handle cli,
        const HTTPCli_Field *fields);

extern char **HTTPCli_setResponseFields(HTTPCli_Handle cli,
        const char *fields[]);

extern int HTTPCli_sendRequest(HTTPCli_Handle cli, const char *method,
        const char *requestURI, bool moreFlag);

extern int HTTPCli_sendField(HTTPCli_Handle cli, const char *name,
        const char *value, bool lastFlag);

extern int HTTPCli_sendRequestBody(HTTPCli_Handle cli, const char *body,
        int len);

extern int HTTPCli_getResponseStatus(HTTPCli_Handle cli);

extern int HTTPCli_getResponseField(HTTPCli_Handle cli, char *value,
        int len, bool *moreFlag);

extern int HTTPCli_readResponseHeader(HTTPCli_Handle cli, char *header,
        int len, bool *moreFlag);

extern int HTTPCli_readResponseBody(HTTPCli_Handle cli, char *body,
        int len, bool *moreFlag);

extern int HTTPCli_readRawResponseBody(HTTPCli_Handle cli, char *body, int len);

extern void HTTPCli_setProxy(const struct sockaddr *addr);

extern int HTTPCli_getSocketError(HTTPCli_Handle cli);

#ifdef __cplusplus
}
#endif

#endif