coreHTTP
v2.0.0
HTTP/1.1 Client Library
|
|
Go to the documentation of this file.
28 #ifndef CORE_HTTP_CLIENT_H_
29 #define CORE_HTTP_CLIENT_H_
38 #ifndef HTTP_DO_NOT_USE_CUSTOM_CONFIG
39 #include "core_http_config.h"
54 #define HTTP_METHOD_GET "GET"
55 #define HTTP_METHOD_PUT "PUT"
56 #define HTTP_METHOD_POST "POST"
57 #define HTTP_METHOD_HEAD "HEAD"
65 #define HTTP_MAX_CONTENT_LENGTH_HEADER_LENGTH sizeof( "Content-Length: 4294967295" ) - 1U
84 #define HTTP_SEND_DISABLE_CONTENT_LENGTH_FLAG 0x1U
106 #define HTTP_REQUEST_KEEP_ALIVE_FLAG 0x1U
127 #define HTTP_RESPONSE_CONNECTION_CLOSE_FLAG 0x1U
135 #define HTTP_RESPONSE_CONNECTION_KEEP_ALIVE_FLAG 0x2U
149 #define HTTP_RANGE_REQUEST_END_OF_FILE -1
155 typedef enum HTTPStatus
322 typedef struct HTTPRequestHeaders
353 typedef struct HTTPRequestInfo
390 typedef struct HTTPClient_ResponseHeaderParsingCallback
401 void ( * onHeaderCallback )(
void * pContext,
402 const char * fieldLoc,
404 const char * valueLoc,
406 uint16_t statusCode );
427 typedef struct HTTPResponse
719 int32_t rangeStartOrlastNbytes,
821 const uint8_t * pRequestBodyBuf,
822 size_t reqBodyBufLen,
824 uint32_t sendFlags );
879 const char ** pValueLoc,
880 size_t * pValueLen );
@ HTTPSecurityAlertInvalidStatusCode
The server sent a response with an invalid character in the HTTP status-code or the HTTP status code ...
Definition: core_http_client.h:262
HTTPStatus_t HTTPClient_ReadHeader(const HTTPResponse_t *pResponse, const char *pField, size_t fieldLen, const char **pValueLoc, size_t *pValueLen)
Read a header from a buffer containing a complete HTTP response. This will return the location of the...
Definition: core_http_client.c:2459
@ HTTPNetworkError
A network error was returned from the transport interface.
Definition: core_http_client.h:187
@ HTTPHeaderNotFound
The requested header field was not found in the response buffer.
Definition: core_http_client.h:299
size_t contentLength
The value in the "Content-Length" header is returned here.
Definition: core_http_client.h:512
size_t bodyLen
Byte length of the body in pBuffer.
Definition: core_http_client.h:496
@ HTTPInsufficientMemory
The application buffer was not large enough for the HTTP request headers or the HTTP response message...
Definition: core_http_client.h:218
const uint8_t * pHeaders
The starting location of the response headers in pBuffer.
Definition: core_http_client.h:475
@ HTTPSuccess
The HTTP Client library function completed successfully.
Definition: core_http_client.h:167
@ HTTPNoResponse
No HTTP response was received from the network.
Definition: core_http_client.h:206
@ HTTPSecurityAlertInvalidProtocolVersion
The server sent a response with an invalid character in the HTTP protocol version.
Definition: core_http_client.h:253
HTTPStatus_t HTTPClient_InitializeRequestHeaders(HTTPRequestHeaders_t *pRequestHeaders, const HTTPRequestInfo_t *pRequestInfo)
Initialize the request headers, stored in HTTPRequestHeaders_t.pBuffer, with initial configurations f...
Definition: core_http_client.c:1521
@ HTTPInvalidParameter
The HTTP Client library function input an invalid parameter.
Definition: core_http_client.h:179
const uint8_t * pBody
The starting location of the response body in pBuffer.
Definition: core_http_client.h:489
const char * pPath
The Request-URI to the objects of interest, e.g. "/path/to/item.txt".
Definition: core_http_client.h:364
@ HTTPSecurityAlertResponseHeadersSizeLimitExceeded
The server sent more headers than the configured HTTP_MAX_RESPONSE_HEADERS_SIZE_BYTES.
Definition: core_http_client.h:227
HTTPStatus_t HTTPClient_AddRangeHeader(HTTPRequestHeaders_t *pRequestHeaders, int32_t rangeStartOrlastNbytes, int32_t rangeEnd)
Add the byte range request header to the request headers store in HTTPRequestHeaders_t....
Definition: core_http_client.c:1678
const char * pMethod
The HTTP request method e.g. "GET", "POST", "PUT", or "HEAD".
Definition: core_http_client.h:358
uint32_t reqFlags
Flags to activate other request header configurations.
Definition: core_http_client.h:380
uint32_t respFlags
Flags of useful headers found in the response.
Definition: core_http_client.h:527
The default values for the configuration macros for the HTTP Client library.
Represents an HTTP response.
Definition: core_http_client.h:428
size_t bufferLen
Definition: core_http_client.h:445
HTTPStatus_t HTTPClient_AddHeader(HTTPRequestHeaders_t *pRequestHeaders, const char *pField, size_t fieldLen, const char *pValue, size_t valueLen)
Add a header to the request headers stored in HTTPRequestHeaders_t.pBuffer.
Definition: core_http_client.c:1618
uint8_t * pBuffer
Buffer for both the raw HTTP header and body.
Definition: core_http_client.h:444
@ HTTPSecurityAlertExtraneousResponseData
A response contained the "Connection: close" header, but there was more data at the end of the comple...
Definition: core_http_client.h:236
size_t headersLen
Byte length of the response headers in pBuffer.
Definition: core_http_client.h:482
size_t hostLen
Definition: core_http_client.h:373
const char * HTTPClient_strerror(HTTPStatus_t status)
Error code to string conversion utility for HTTP Client library.
Definition: core_http_client.c:2524
HTTPStatus_t
The HTTP Client library return status.
Definition: core_http_client.h:156
HTTPClient_GetCurrentTimeFunc_t getTime
Optional callback for getting the system time.
Definition: core_http_client.h:468
@ HTTPParserInternalError
An error occurred in the third-party parsing library.
Definition: core_http_client.h:291
HTTPClient_ResponseHeaderParsingCallback_t * pHeaderParsingCallback
Optional callback for intercepting the header during the first parse through of the response as is it...
Definition: core_http_client.h:452
@ HTTPSecurityAlertInvalidCharacter
An invalid character was found in the HTTP response message or in the HTTP request header.
Definition: core_http_client.h:272
const char * pHost
The server's host name, e.g. "my-storage.my-cloud.com".
Definition: core_http_client.h:372
Configurations of the initial request headers.
Definition: core_http_client.h:354
@ HTTPSecurityAlertInvalidContentLength
The response contains either an invalid character in the Content-Length header or a Content-Length he...
Definition: core_http_client.h:282
size_t headerCount
Count of the headers sent by the server.
Definition: core_http_client.h:519
HTTPStatus_t HTTPClient_Send(const TransportInterface_t *pTransport, HTTPRequestHeaders_t *pRequestHeaders, const uint8_t *pRequestBodyBuf, size_t reqBodyBufLen, HTTPResponse_t *pResponse, uint32_t sendFlags)
Send the request headers in HTTPRequestHeaders_t.pBuffer and request body in pRequestBodyBuf over the...
Definition: core_http_client.c:2118
@ HTTPSecurityAlertInvalidChunkHeader
The server sent a chunk header containing an invalid character.
Definition: core_http_client.h:244
@ HTTPInvalidResponse
The HTTP response, provided for parsing, is either corrupt or incomplete.
Definition: core_http_client.h:308
@ HTTPPartialResponse
Part of the HTTP response was received from the network.
Definition: core_http_client.h:195
size_t methodLen
Definition: core_http_client.h:359
Transport interface definitions to send and receive data over the network.
size_t pathLen
Definition: core_http_client.h:365
uint16_t statusCode
The HTTP response Status-Code.
Definition: core_http_client.h:505
uint32_t(* HTTPClient_GetCurrentTimeFunc_t)(void)
Application provided function to query the current time in milliseconds.
Definition: core_http_client.h:421
The transport layer interface.
Definition: transport_interface.h:246