coreHTTP v3.1.1
HTTP/1.1 Client Library
 
Loading...
Searching...
No Matches
HTTPRequestInfo_t Flags

Flags for HTTPRequestInfo_t.reqFlags. These flags control what headers are written or not to the HTTPRequestHeaders_t.pBuffer by HTTPClient_InitializeRequestHeaders. More...

Macros

#define HTTP_REQUEST_KEEP_ALIVE_FLAG   0x1U
 Set this flag to indicate that the request is for a persistent connection.
 
#define HTTP_REQUEST_NO_USER_AGENT_FLAG   0x2U
 Set this flag to skip the User-Agent in the request headers.
 

Detailed Description

Flags for HTTPRequestInfo_t.reqFlags. These flags control what headers are written or not to the HTTPRequestHeaders_t.pBuffer by HTTPClient_InitializeRequestHeaders.

Flags should be bitwise-ORed with each other to change the behavior of HTTPClient_InitializeRequestHeaders.

Macro Definition Documentation

◆ HTTP_REQUEST_KEEP_ALIVE_FLAG

#define HTTP_REQUEST_KEEP_ALIVE_FLAG   0x1U

Set this flag to indicate that the request is for a persistent connection.

Setting this will cause a "Connection: Keep-Alive" to be written to the request headers.

This flag is valid only for HTTPRequestInfo_t reqFlags parameter.

◆ HTTP_REQUEST_NO_USER_AGENT_FLAG

#define HTTP_REQUEST_NO_USER_AGENT_FLAG   0x2U

Set this flag to skip the User-Agent in the request headers.

Setting this will cause the "User-Agent: <Value>" to be omitted in the request headers.

This flag is valid only for HTTPRequestInfo_t reqFlags parameter.