FreeRTOS: HTTPS Client
HTTPS Client v1.0.0 library
Return to main page ↑
_httpsConnection_t Struct Reference

Represents an HTTP connection. More...

#include <iot_https_internal.h>

Data Fields

const IotNetworkInterface_tpNetworkInterface
 Network interface with calls for connect, disconnect, send, and receive.
 
void * pNetworkConnection
 Pointer to the network connection to use pNetworkInterface calls on.
 
uint32_t timeout
 Timeout for a connection and waiting for a response from the network.
 
bool isConnected
 true if a connection was successful most recently on this context More...
 
bool isDestroyed
 true if the connection is already destroyed and we should call anymore

 
IotMutex_t connectionMutex
 Mutex protecting operations on this entire connection context.
 
IotDeQueue_t reqQ
 The queue for the requests that are not finished yet.
 
IotDeQueue_t respQ
 The queue for the responses that are waiting to be processed.
 
IotTaskPoolJobStorage_t taskPoolJobStorage
 An asynchronous operation requires storage for the task pool job.
 
IotTaskPoolJob_t taskPoolJob
 The task pool job identifier for an asynchronous request.
 

Detailed Description

Represents an HTTP connection.

Field Documentation

◆ isConnected

bool _httpsConnection_t::isConnected

true if a connection was successful most recently on this context

We have no way of knowing if the server closed the connection because that error is unique to the underlying TLS layer. This is set to false initially, then set to true for a successful intentional call to connect. Post connection, this is set to false only after an implicit disconnect with a non-persistent request, an implicit disconnect with a network error, or an explicit disconnect with a call to IotHttpsClient_Disconnect.


The documentation for this struct was generated from the following file: