HTTP client

HTTP/1.1 client API. More...

Data Structures
struct	HTTPCli_Field
	HTTPCli request header field. More...
struct	HTTPCli_StatusHandler
	HTTPCli response status code handler type. More...
struct	HTTPCli_ContentHandler
	HTTPCli content handler type. More...
struct	HTTPCli_Struct
	HTTPCli instance type. More...
struct	HTTPCli_Params
	HTTPCli instance paramaters. More...

Macros
#define	HTTPCli_BUF_LEN   128
#define	HTTPCli_RECV_BUFLEN   32

Typedefs
typedef struct HTTPCli_Field	HTTPCli_Field
	HTTPCli request header field. More...
typedef void(*	HTTPCli_StatusCallback) (void *cli, int status)
	HTTPCli callback function for status handling. More...
typedef struct HTTPCli_StatusHandler	HTTPCli_StatusHandler
	HTTPCli response status code handler type. More...
typedef int(*	HTTPCli_ContentCallback) (void *cli, int status, char *body, int len, bool moreFlag)
	HTTPCli callback function for content handling. More...
typedef struct HTTPCli_ContentHandler	HTTPCli_ContentHandler
	HTTPCli content handler type. More...
typedef void(*	HTTPCli_RedirectCallback) (void *cli, int status, char *uri)
	HTTPCli callback function prototype for redirection handling. More...
typedef struct HTTPCli_Struct	HTTPCli_Struct
	HTTPCli instance type. More...
typedef struct HTTPCli_Params	HTTPCli_Params
	HTTPCli instance paramaters. More...
typedef HTTPCli_Struct *	HTTPCli_Handle

Functions
void	HTTPCli_Params_init (HTTPCli_Params *params)
	Initialize the HTTPCli Params structure to default values. More...
int	HTTPCli_initSockAddr (struct sockaddr *addr, const char *uri, int flags)
	Initialize the socket address structure for the given URI. More...
void	HTTPCli_construct (HTTPCli_Struct *cli)
	Create a new instance object in the provided structure. More...
HTTPCli_Handle	HTTPCli_create ()
	Allocate and initialize a new instance object and return its handle. More...
int	HTTPCli_connect (HTTPCli_Handle cli, const struct sockaddr *addr, int flags, const HTTPCli_Params *params)
	Open a connection to an HTTP server. More...
void	HTTPCli_delete (HTTPCli_Handle *cli)
	Destroy the HTTP client instance and free the previously allocated instance object. More...
void	HTTPCli_destruct (HTTPCli_Struct *cli)
	Destroy the HTTP client instance. More...
void	HTTPCli_disconnect (HTTPCli_Handle cli)
	Disconnect from the HTTP server and destroy the HTTP client instance. More...
HTTPCli_Field *	HTTPCli_setRequestFields (HTTPCli_Handle cli, const HTTPCli_Field *fields)
	Set an array of header fields to be sent for every HTTP request. More...
char **	HTTPCli_setResponseFields (HTTPCli_Handle cli, const char *fields[])
	Set the header fields to filter the response headers. More...
int	HTTPCli_sendRequest (HTTPCli_Handle cli, const char *method, const char *requestURI, bool moreFlag)
	Make an HTTP 1.1 request to the HTTP server. More...
int	HTTPCli_sendField (HTTPCli_Handle cli, const char *name, const char *value, bool lastFlag)
	Send an header field to the HTTP server. More...
int	HTTPCli_sendRequestBody (HTTPCli_Handle cli, const char *body, int len)
	Send the request message body to the HTTP server. More...
int	HTTPCli_getResponseStatus (HTTPCli_Handle cli)
	Process the response header from the HTTP server and return status. More...
int	HTTPCli_getResponseField (HTTPCli_Handle cli, char *value, int len, bool *moreFlag)
	Process a response header from the HTTP server and return field. More...
int	HTTPCli_readResponseHeader (HTTPCli_Handle cli, char *header, int len, bool *moreFlag)
	Read a response header from the HTTP server. More...
int	HTTPCli_readResponseBody (HTTPCli_Handle cli, char *body, int len, bool *moreFlag)
	Read the parsed response body data from the HTTP server. More...
int	HTTPCli_readRawResponseBody (HTTPCli_Handle cli, char *body, int len)
	Read the raw response message body from the HTTP server. More...
void	HTTPCli_setProxy (const struct sockaddr *addr)
	Set the proxy address. More...
int	HTTPCli_getSocketError (HTTPCli_Handle cli)
	Get the error code from the socket/TLS layer. More...

HTTP Client Error Codes
#define	HTTPCli_ESOCKETFAIL   (-101)
	Socket create failed. More...
#define	HTTPCli_ECONNECTFAIL   (-102)
	Cannot connect to the remote host. More...
#define	HTTPCli_ESENDFAIL   (-103)
	Cannot send to the remote host. More...
#define	HTTPCli_ERECVFAIL   (-104)
	Cannot recieve data from the remote host. More...
#define	HTTPCli_ETLSFAIL   (-105)
	Failed to configure the socket with TLS parameters. More...
#define	HTTPCli_EHOSTNAME   (-106)
	Failed to resolve host name. More...
#define	HTTPCli_ESENDBUFSMALL   (-107)
	Internal send buffer is not big enough. More...
#define	HTTPCli_ERECVBUFSMALL   (-108)
	Receive buffer is not big enough. More...
#define	HTTPCli_EASYNCMODE   (-109)
	HTTPCli_getResponseStatus() should not be called in async mode More...
#define	HTTPCli_ETHREADFAIL   (-110)
	Thread create failed. More...
#define	HTTPCli_EPROXYTUNNELFAIL   (-111)
	Failed to create an HTTP tunnel through proxy. More...
#define	HTTPCli_ERESPONSEINVALID   (-112)
	Response recieved from the server is not a valid HTTP/1.1 response. More...
#define	HTTPCli_ECONTENTLENLARGE   (-114)
	Content length returned is too large. More...
#define	HTTPCli_EREDIRECTURILONG   (-115)
	Redirection URI returned is too long to be read into the buffer. More...
#define	HTTPCli_ECONTENTTYPELONG   (-116)
	Content type returned is too long to be read into buffer. More...
#define	HTTPCli_ENOCONTENTCALLBACK   (-117)
	Received content type does not match any registered callback. More...
#define	HTTPCli_ENOTCHUNKDATA   (-118)
	Data is not of chunked type. More...
#define	HTTPCli_EINPROGRESS   (-119)
	Operation could not be completed. Try again. More...
#define	HTTPCli_EINTERNALBUFSMALL   (-120)
	Internal instance buffer to send/recieve data is too small. More...
#define	HTTPCli_ESETNOTIFYFAIL   (-121)
	Could not setup the notify callbacks. More...
#define	HTTPCli_EURILENLONG   (-122)
	Input domain name length is too long to be read into buffer. More...
#define	HTTPCli_EHOSTFIELDNOTFOUND   (-123)
	Request Field 'Host' is not found in the set array. More...

HTTP Client Configuration Types
#define	HTTPCli_TYPE_TLS   (0x02)
#define	HTTPCli_TYPE_IPV6   (0x04)

HTTP Client Field ID
Special return codes for HTTPCli_getResponseField().
#define	HTTPCli_FIELD_ID_DUMMY   (-11)
#define	HTTPCli_FIELD_ID_END   (-12)

Detailed Description

HTTP/1.1 client API.

This module provides an HTTP client implementation of IETF standard for HTTP/1.1 - RFC 2616 and TLS support to interact with HTTP/1.1 servers.

Features

• Supports GET, POST, PUT, HEAD, OPTIONS, DELETE methods, request and response headers/bodies, and redirection response handling.
• Using this module, connections can be opened/closed to HTTP servers. Each connection is an instance which can be configured with a set of repeated requests/responses parameters so that they can be used across multiple transactions.
• For supporting small memory devices, the module has been specially designed with split request/response APIs which enables sending requests and responses in smaller chunks, and static memory based APIs to eliminate the need for dynamic memory allocations.
• Supports security features which include TLS and communication through proxy.
• Supports two types of programming models: synchronous and asynchronous modes. In the default synchronous mode, an application uses APIs to make a request to the server and blocks until the server responds. With asynchronous mode, a thread to handle the response is created which invokes callbacks registered with the module.
• Supports TI-RTOS NDK, SimpleLink WiFi and Linux networking stacks. At IP level supports both IPv4 and IPv6.
• Supports conditional compilation of the module to include/exclude some of the features mentioned above.

Limitations

• HTTP client on SimpleLink WiFi supports IPv4 only.
• HTTP servers sending response header field name > 24 bytes are skipped. This length is controlled by the 'MAX_FIELD_NAME_LEN' macro in 'httpcli.c'. Modify the macro and rebuild the library if needed.

Deprecated Macros

The macros HTTPCli_METHOD* and HTTPCli_FIELD_NAME* have been deprecated. Use HTTPStd_* macros from the HTTP Standard Definitions link below.

For backward compatibility, the old macros can still be used if -Dti_net_http_HTTPCli__deprecated is added to the compile options.

Minimal HTTP Client library

A minimal flavor of the library without asynchronous callback support which includes status handling, content handling and redirection handling can be built. The default library has support for these features.

To rebuild the library, add "-DHTTPCli_LIBTYPE_MIN" to the compile line and rebuild. The same option has to be added on application compile line also.

See also

• HTTP Standard Definitions for HTTP Status Codes, Content Types and Header Fields.
• TLS for TLS APIs.

Examples

The basic flow of managing an HTTP client is shown in the pseudo codes below. For clarity, return values are ignored - in a real application, these should be checked for errors.

• HTTP GET Example

  #include <ti/net/http/httpcli.h>
  
  HTTPCli_Struct cli;
  
  // Request fields
  HTTPCli_Field fields[2] = {
      { HTTPStd_FIELD_NAME_HOST,  "www.example.com" },
      { NULL, NULL }
  };
  
  // Response field filters
  char respFields[2] = {
      HTTPStd_FIELD_NAME_CONTENT_LENGTH,
      NULL
  };
  
  // Construct a static HTTP client instance
  HTTPCli_construct(&cli);
  
  HTTPCli_setRequestFields(&cli, fields);
  
  HTTPCli_setResponseFields(&cli, respFields);
  
  // Connect to the HTTP Server
  HTTPCli_connect(&cli, &addr, 0, NULL);
  
  // Make HTTP 1.1 GET request
  //
  // Send request to the server:
  //
  // GET /index.html HTTP/1.1
  // Host: www.example.com
  // <blank line>
  HTTPCli_sendRequest(&cli, HTTPStd_GET, "/index.html", false);
  
  //
  // Get the processed response status
  //
  // HTTP/1.1 200 OK
  status = HTTPCli_getResponseStatus(&cli);
  
  // Check the HTTP return status and process remaining response
  if (status == HTTPStd_OK) {
      do {
          //Filter the response headers and get the set response field
          //
          // ...
          // Content-type: text/xml; charset=utf-8\r\n
          // Content-length: 34
          // ...
          ret = HTTPCli_getResponseField(&cli, buf, sizeof(buf), &moreFlag);
  
          //
          // Process data in buf if field is content length
          //
          // Zero is the index of Content length in respFields array
          if (ret == 0) {
              len = (int)strtoul(buf, NULL, 0);
          }
      } while (ret != HTTPCli_FIELD_ID_END);
  
      while (len > 0) {
          len -= HTTPCli_readRawResponseBody(&cli, buf, sizeof(buf));
          // ... process buf data and save ...
      }
  }
  
  HTTPCli_disconnect(&cli);
  
  HTTPCli_destruct(&cli);

• HTTPS POST Example

  #include <ti/net/http/httpcli.h>
  
  // For SimpleLink, include sssl.h instead
  #include <ti/net/http/sswolfssl.h>
  
  HTTPCli_Struct cli;
  
  // Request fields
  HTTPCli_Field fields[2] = {
      { HTTPStd_FIELD_NAME_HOST,  "www.example.com" },
      { NULL, NULL }
  };
  
  // Response field filters
  char respFields[2] = {
      HTTPStd_FIELD_NAME_CONTENT_LENGTH,
      NULL
  };
  
  // Set up wolfSSL context
  // For SimpleLink, use SSSl_setContext() instead
  SSWolfssl_setContext(ctx);
  
  // Construct a static HTTP client instance
  HTTPCli_construct(&cli);
  
  HTTPCli_setRequestFields(&cli, fields);
  
  HTTPCli_setResponseFields(&cli, respFields);
  
  // Connect securely to the HTTPS Server
  HTTPCli_connect(&cli, &addr, HTTPCli_TYPE_TLS, NULL);
  
  // Make HTTP 1.1 POST request
  //
  // Send request to the server:
  //
  // POST /index.html HTTP/1.1
  // Host: www.example.com
  HTTPCli_sendRequest(&cli, HTTPStd_POST, "/index.html", true);
  
  // Send additional fields
  //
  // Content-Length: <length>
  // <blank line>
  HTTPCli_sendField(&cli, HTTPStd_FIELD_NAME_CONTENT_LENGTH, len, true);
  
  // Send request body
  //
  // <data>
  HTTPCli_sendRequestBody(&cli, data, strlen(data));
  
  // Get the processed response status
  //
  // HTTP/1.1 200 OK
  status = HTTPCli_getResponseStatus(&cli);
  
  // Check the HTTP return status and process remaining response
  if (status == HTTPStd_OK) {
      do {
          // Filter the response headers and get the set response field
          //
          //...
          // Content-type: text/xml; charset=utf-8\r\n
          // Content-length: 34
          //  ...
          ret = HTTPCli_getResponseField(&cli, buf, sizeof(buf), &moreFlag);
  
          //  Process data in buf if field is content length
          //  Zero is the index of Content length in respFields array
          if (ret == 0) {
              len = (int)strtoul(buf, NULL, 0);
          }
  
      } while (ret != HTTPCli_FIELD_ID_END);
  
      while (len > 0) {
          len -= HTTPCli_readRawResponseBody(&cli, buf, sizeof(buf));
          // ... process buf data and save ...
      }
   }
  
   HTTPCli_disconnect(&cli);
  
   HTTPCli_destruct(&cli);

Macro Definition Documentation

#define HTTPCli_BUF_LEN   128

Modify the HTTP client object's internal buffer length and rebuild the library if needed.

#define HTTPCli_RECV_BUFLEN   32

Minimum size required to hold content length string

#define HTTPCli_ESOCKETFAIL   (-101)

Socket create failed.

See also

HTTPCli_getSocketError()

#define HTTPCli_ECONNECTFAIL   (-102)

Cannot connect to the remote host.

See also

HTTPCli_getSocketError()

#define HTTPCli_ESENDFAIL   (-103)

Cannot send to the remote host.

See also

HTTPCli_getSocketError()

#define HTTPCli_ERECVFAIL   (-104)

Cannot recieve data from the remote host.

See also

HTTPCli_getSocketError()

#define HTTPCli_ETLSFAIL   (-105)

Failed to configure the socket with TLS parameters.

See also

HTTPCli_getSocketError()

#define HTTPCli_EHOSTNAME   (-106)

Failed to resolve host name.

#define HTTPCli_ESENDBUFSMALL   (-107)

Internal send buffer is not big enough.

Modify the SEND_BUFLEN macro in the httpcli.c and rebuild the library if needed.

#define HTTPCli_ERECVBUFSMALL   (-108)

Receive buffer is not big enough.

The length of buffer parameter in HTTPCli_getResponseField() should be at least HTTPCli_RECV_BUFLEN.

#define HTTPCli_EASYNCMODE   (-109)

HTTPCli_getResponseStatus() should not be called in async mode

#define HTTPCli_ETHREADFAIL   (-110)

Thread create failed.

#define HTTPCli_EPROXYTUNNELFAIL   (-111)

Failed to create an HTTP tunnel through proxy.

#define HTTPCli_ERESPONSEINVALID   (-112)

Response recieved from the server is not a valid HTTP/1.1 response.

#define HTTPCli_ECONTENTLENLARGE   (-114)

Content length returned is too large.

The length of buffer parameter in HTTPCli_getResponseField() is not sufficient

#define HTTPCli_EREDIRECTURILONG   (-115)

Redirection URI returned is too long to be read into the buffer.

Modify the URI_BUFLEN macro in the httpcli.c and rebuild the library if needed.

#define HTTPCli_ECONTENTTYPELONG   (-116)

Content type returned is too long to be read into buffer.

#define HTTPCli_ENOCONTENTCALLBACK   (-117)

Received content type does not match any registered callback.

Modify the CONTENT_BUFLEN macro in the httpcli.c and rebuild the library if needed.

#define HTTPCli_ENOTCHUNKDATA   (-118)

Data is not of chunked type.

#define HTTPCli_EINPROGRESS   (-119)

Operation could not be completed. Try again.

#define HTTPCli_EINTERNALBUFSMALL   (-120)

Internal instance buffer to send/recieve data is too small.

#define HTTPCli_ESETNOTIFYFAIL   (-121)

Could not setup the notify callbacks.

#define HTTPCli_EURILENLONG   (-122)

Input domain name length is too long to be read into buffer.

Modify the DOMAIN_BUFLEN macro in the httpcli.c and rebuild the library if needed.

#define HTTPCli_EHOSTFIELDNOTFOUND   (-123)

Request Field 'Host' is not found in the set array.

'Host' should be set in the 'fields' parameter of HTTPCli_setRequestFields(). This is used to set up an HTTP tunnel through proxy servers.

#define HTTPCli_TYPE_TLS   (0x02)

#define HTTPCli_TYPE_IPV6   (0x04)

#define HTTPCli_FIELD_ID_DUMMY   (-11)

#define HTTPCli_FIELD_ID_END   (-12)

Typedef Documentation

typedef struct HTTPCli_Field HTTPCli_Field

HTTPCli request header field.

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

HTTPCli callback function for status handling.

Parameters

[in]	cli	Instance of the HTTP connection
[in]	status	Response status code

typedef struct HTTPCli_StatusHandler HTTPCli_StatusHandler

HTTPCli response status code handler type.

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

HTTPCli callback function for content handling.

Parameters

[in]	cli	Instance of the HTTP connection
[in]	status	Response status code
[in]	body	Data from the response body
[in]	len	Length of response body buffer
[in]	moreFlag	Set if more response data is available

Returns

1 to continue or 0 to stop further processing.

typedef struct HTTPCli_ContentHandler HTTPCli_ContentHandler

HTTPCli content handler type.

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

HTTPCli callback function prototype for redirection handling.

Parameters

[in]	cli	Instance of the HTTP connection
[in]	status	Response status code
[in]	uri	The new URI string

typedef struct HTTPCli_Struct HTTPCli_Struct

HTTPCli instance type.

Remarks

This doxygen does not document all data fields. See httpcli.h for complete details.

typedef struct HTTPCli_Params HTTPCli_Params

HTTPCli instance paramaters.

Remarks

This doxygen does not document all data fields. See httpcli.h for complete details.

typedef HTTPCli_Struct* HTTPCli_Handle

Function Documentation

void HTTPCli_Params_init

(

HTTPCli_Params *

params

)

Initialize the HTTPCli Params structure to default values.

Parameters

[in]

params

A pointer to the HTTPCli_Params struct

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

Initialize the socket address structure for the given URI.

The supported URI format is:

• [http[s]://]host_name[:port_number][/request_uri]

For cases where port is not provided, the default port number is set.

Parameters

[out]	addr	Handle to the sockaddr structure
[in]	uri	A null terminated URI string
[in]	flags	Set HTTPCli_TYPE_IPV6 for IPv6 addresses.

Remarks

SimpleLink stack does not support IPv6.

Returns

0 on success or error code on failure.

void HTTPCli_construct

(

HTTPCli_Struct *

cli

)

Create a new instance object in the provided structure.

Parameters

[out]

cli

Instance of an HTTP client

HTTPCli_Handle HTTPCli_create

(

)

Allocate and initialize a new instance object and return its handle.

Returns

handle of the HTTP client instance on success or NULL on failure.

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

Open a connection to an HTTP server.

Parameters

[in]	cli	Instance of an HTTP client
[in]	addr	IP address of the server. Can be NULL when proxy is set.
[in]	flags	Reserved for future use
[in]	params	Per-instance config params, or NULL for default values

Returns

0 on success or error code on failure.

void HTTPCli_delete

(

HTTPCli_Handle *

cli

)

Destroy the HTTP client instance and free the previously allocated instance object.

Parameters

[in]

cli

Pointer to the HTTP client instance

void HTTPCli_destruct

(

HTTPCli_Struct *

cli

)

Destroy the HTTP client instance.

Parameters

[in]

cli

Instance of the HTTP client

void HTTPCli_disconnect

(

HTTPCli_Handle

cli

)

Disconnect from the HTTP server and destroy the HTTP client instance.

Parameters

[in]

cli

Instance of the HTTP client

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

Set an array of header fields to be sent for every HTTP request.

Parameters

[in]	cli	Instance of an HTTP client
[in]	fields	An array of HTTP request header fields terminated by an object with NULL fields, or NULL to get previously set array.

Remarks

The array should be persistant for lifetime of the HTTP instance.

Returns

previously set array

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

Set the header fields to filter the response headers.

Parameters

[in]	cli	Instance of an HTTP client
[in]	fields	An array of HTTP response header field strings terminated by a NULL, or NULL to get previously set array.

Remarks

The array should be persistant for lifetime of the HTTP instance.

Returns

previously set array

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

Make an HTTP 1.1 request to the HTTP server.

Sends an HTTP 1.1 request-line and the header fields from the user set array (see HTTPCli_setRequestFields()) to the server.

Additionally, more fields apart from the user set array of header fields can be sent to the server. To send more fields, set the moreFlag when calling this function and then call HTTPCli_sendField() with more fields.

Parameters

[in]	cli	Instance of an HTTP client
[in]	method	HTTP 1.1 method (ex: HTTPStd_GET)
[in]	requestURI	the path on the server to open and any CGI parameters
[in]	moreFlag	Set this flag when more fields will sent to the server

Returns

0 on success or error code on failure

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

Send an header field to the HTTP server.

This is a complementary function to HTTPCli_sendRequest() when more header fields are to be sent to the server.

Parameters

[in]	cli	Instance of an HTTP client
[in]	name	HTTP 1.1 request header field (ex: HTTPStd_FIELD_NAME_HOST)
[in]	value	HTTP 1.1 request header field value
[in]	lastFlag	Set this flag when sending the last header field

Returns

0 on success or error code on failure

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

Send the request message body to the HTTP server.

Make a call to this function after HTTPCli_sendRequest() (always) and HTTPCli_sendField() (if applicable).

Parameters

[in]	cli	Instance of an HTTP client
[in]	body	Request body buffer
[in]	len	Length of the request body buffer

Returns

0 on success or error code on failure

int HTTPCli_getResponseStatus

(

HTTPCli_Handle

cli

)

Process the response header from the HTTP server and return status.

Remarks

Do not call in asyncronous mode. This function will return HTTPCli_EASYNCMODE.

Parameters

[in]

cli

Instance of an HTTP client

Returns

On success, status code from the server or error code on failure.

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

Process a response header from the HTTP server and return field.

Filters the response headers based on the array of fields (see HTTPCli_setResponseFields()).

Repeatedly call this function until HTTPCli_FIELD_ID_END is returned.

Parameters

[in]	cli	Instance of an HTTP client
[out]	value	Field value string.
[in]	len	Length of field value string
[out]	moreFlag	Flag set if the field value could not be completely read into value. A subsequent call to this function will read the remaining field value into value and will return HTTPCli_FIELD_ID_DUMMY.

Returns

On Success, the index of the field set in the HTTPCli_setResponseFields() or HTTPCli_FIELD_ID_END or HTTPCli_FIELD_ID_DUMMY, or error code on failure.

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

Read a response header from the HTTP server.

Repeatedly call this function until zero is returned.

Parameters

[in]	cli	Instance of an HTTP client
[out]	header	Buffer to hold Response Header string
[in]	len	Length of the buffer
[out]	moreFlag	Flag set if the field value could not be completely read into header. A subsequent call to this function will read the remaining field value into header

Returns

The number of characters read (including NULL character) on success or error code on failure

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

Read the parsed response body data from the HTTP server.

This function parses the response body if the content type is chunked transfer encoding or if the content length field is returned by the HTTP server.

Make a call to this function only after the call to HTTPCli_getResponseStatus() and HTTPCli_getResponseField().

Parameters

[in]	cli	Instance of an HTTP client
[out]	body	Response body buffer
[in]	len	Length of response body buffer
[out]	moreFlag	Set if more data is available

Returns

The number of characters read on success or error code on failure

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

Read the raw response message body from the HTTP server.

Make a call to this function only after the call to HTTPCli_getResponseStatus() and HTTPCli_getResponseField().

Repeatedly call this function until entire response message is read.

Parameters

[in]	cli	Instance of an HTTP client
[out]	body	Response body buffer
[in]	len	Length of response body buffer

Returns

The number of characters read on success or error code on failure

void HTTPCli_setProxy

(

const struct sockaddr *

addr

)

Set the proxy address.

Parameters

[in]

addr

IP address of the proxy server

int HTTPCli_getSocketError

(

HTTPCli_Handle

cli

)

Get the error code from the socket/TLS layer.

If the returned error from the HTTPCli APIs is either a socket failure code (HTTPCli_ESOCKETFAIL or HTTPCli_ECONNECTFAIL or HTTPCli_ESENDFAIL or HTTPCli_ERECVFAIL) or a TLS failure code (HTTPCli_ETLSFAIL), a call to this function may provide the socket/TLS layer error code.

Parameters

[in]

cli

Instance of an HTTP client

Returns

The error code from the socket/TLS layer or zero.

Remarks

errno set by the network stacks are not returned by this function. The application has to check errno for such stacks.