HTTP client context. More...
#include <http_client.h>
Data Fields | |
| HttpClientState | state |
| HTTP client state. More... | |
| HttpVersion | version |
| HTTP protocol version. More... | |
| NetInterface * | interface |
| Underlying network interface. More... | |
| systime_t | timeout |
| Timeout value. More... | |
| systime_t | timestamp |
| Timestamp to manage timeout. More... | |
| Socket * | socket |
| Underlying socket. More... | |
| TlsContext * | tlsContext |
| TLS context. More... | |
| TlsSessionState | tlsSession |
| TLS session state. More... | |
| HttpClientTlsInitCallback | tlsInitCallback |
| TLS initialization callback function. More... | |
| void * | tlsInitParam |
| Opaque pointer passed to the callback function. More... | |
| IpAddr | serverIpAddr |
| IP address of the HTTP server. More... | |
| uint16_t | serverPort |
| TCP port number. More... | |
| HttpClientAuthParams | authParams |
| HTTP authentication parameters. More... | |
| HttpClientRandCallback | randCallback |
| Random data generation callback function. More... | |
| HttpRequestState | requestState |
| HTTP request state. More... | |
| char_t | method [HTTP_CLIENT_MAX_METHOD_LEN+1] |
| HTTP request method. More... | |
| bool_t | keepAlive |
| HTTP persistent connection. More... | |
| bool_t | chunkedEncoding |
| Chunked transfer encoding. More... | |
| char_t | buffer [HTTP_CLIENT_BUFFER_SIZE+1] |
| Memory buffer for input/output operations. More... | |
| size_t | bufferLen |
| Length of the buffer, in bytes. More... | |
| size_t | bufferPos |
| Current position in the buffer. More... | |
| size_t | bodyLen |
| Length of the body, in bytes. More... | |
| size_t | bodyPos |
| Current position in the body. More... | |
| uint_t | statusCode |
| HTTP status code. More... | |
Detailed Description
HTTP client context.
Definition at line 266 of file http_client.h.
Field Documentation
◆ authParams
| HttpClientAuthParams authParams |
HTTP authentication parameters.
Definition at line 283 of file http_client.h.
◆ bodyLen
| size_t bodyLen |
Length of the body, in bytes.
Definition at line 295 of file http_client.h.
◆ bodyPos
| size_t bodyPos |
Current position in the body.
Definition at line 296 of file http_client.h.
◆ buffer
| char_t buffer[HTTP_CLIENT_BUFFER_SIZE+1] |
Memory buffer for input/output operations.
Definition at line 292 of file http_client.h.
◆ bufferLen
| size_t bufferLen |
Length of the buffer, in bytes.
Definition at line 293 of file http_client.h.
◆ bufferPos
| size_t bufferPos |
Current position in the buffer.
Definition at line 294 of file http_client.h.
◆ chunkedEncoding
| bool_t chunkedEncoding |
Chunked transfer encoding.
Definition at line 291 of file http_client.h.
◆ interface
| NetInterface* interface |
Underlying network interface.
Definition at line 270 of file http_client.h.
◆ keepAlive
| bool_t keepAlive |
HTTP persistent connection.
Definition at line 290 of file http_client.h.
◆ method
| char_t method[HTTP_CLIENT_MAX_METHOD_LEN+1] |
HTTP request method.
Definition at line 289 of file http_client.h.
◆ randCallback
| HttpClientRandCallback randCallback |
Random data generation callback function.
Definition at line 286 of file http_client.h.
◆ requestState
| HttpRequestState requestState |
HTTP request state.
Definition at line 288 of file http_client.h.
◆ serverIpAddr
| IpAddr serverIpAddr |
IP address of the HTTP server.
Definition at line 280 of file http_client.h.
◆ serverPort
| uint16_t serverPort |
TCP port number.
Definition at line 281 of file http_client.h.
◆ socket
| Socket* socket |
Underlying socket.
Definition at line 273 of file http_client.h.
◆ state
| HttpClientState state |
HTTP client state.
Definition at line 268 of file http_client.h.
◆ statusCode
| uint_t statusCode |
HTTP status code.
Definition at line 297 of file http_client.h.
◆ timeout
| systime_t timeout |
Timeout value.
Definition at line 271 of file http_client.h.
◆ timestamp
| systime_t timestamp |
Timestamp to manage timeout.
Definition at line 272 of file http_client.h.
◆ tlsContext
| TlsContext* tlsContext |
TLS context.
Definition at line 275 of file http_client.h.
◆ tlsInitCallback
| HttpClientTlsInitCallback tlsInitCallback |
TLS initialization callback function.
Definition at line 277 of file http_client.h.
◆ tlsInitParam
| void* tlsInitParam |
Opaque pointer passed to the callback function.
Definition at line 278 of file http_client.h.
◆ tlsSession
| TlsSessionState tlsSession |
TLS session state.
Definition at line 276 of file http_client.h.
◆ version
| HttpVersion version |
HTTP protocol version.
Definition at line 269 of file http_client.h.
The documentation for this struct was generated from the following file:
- cyclone_tcp/http/http_client.h