Opaque handles of the platform layer. More...

Typedefs
typedef _IotSystemMutex_t	IotMutex_t
	The type used to represent mutexes, configured with the type `_IotSystemMutex_t`. More...

typedef _IotSystemSemaphore_t	IotSemaphore_t
	The type used to represent semaphores, configured with the type `_IotSystemSemaphore_t`. More...

typedef _IotSystemTimer_t	IotTimer_t
	The type used to represent timers, configured with the type `_IotSystemTimer_t`. More...

typedef _IotNetworkServerInfo_t	IotNetworkServerInfo_t
	The type used to represent network server info, configured with the type `_IotNetworkServerInfo_t`. More...

typedef _IotNetworkCredentials_t	IotNetworkCredentials_t
	The type used to represent network credentials, configured with the type `_IotNetworkCredentials_t`. More...

typedef _IotNetworkConnection_t	IotNetworkConnection_t
	The type used to represent network connections, configured with the type `_IotNetworkConnection_t`. More...

Detailed Description

Opaque handles of the platform layer.

Typedef Documentation

◆ IotMutex_t

typedef _IotSystemMutex_t IotMutex_t

The type used to represent mutexes, configured with the type _IotSystemMutex_t.

For the provided ports, _IotSystemMutex_t will be automatically configured. For other ports, _IotSystemMutex_t should be set in iot_config.h.

Mutexes should only be released by the threads that take them.

Example
To change the type of IotMutex_t to long:

typedef long _IotSystemMutex_t;

#include "iot_threads.h"

◆ IotSemaphore_t

typedef _IotSystemSemaphore_t IotSemaphore_t

The type used to represent semaphores, configured with the type _IotSystemSemaphore_t.

For the provided ports, _IotSystemSemaphore_t will be automatically configured. For other ports, _IotSystemSemaphore_t should be set in iot_config.h.

Semaphores must be counting, and any thread may take (wait on) or release (post to) a semaphore.

Example
To change the type of IotSemaphore_t to long:

typedef long _IotSystemSemaphore_t;

#include "iot_threads.h"

◆ IotTimer_t

typedef _IotSystemTimer_t IotTimer_t

The type used to represent timers, configured with the type _IotSystemTimer_t.

For the provided ports, _IotSystemTimer_t will be automatically configured. For other ports, _IotSystemTimer_t should be set in iot_config.h.

Example
To change the type of IotTimer_t to long:

typedef long _IotSystemTimer_t;

#include "iot_clock.h"

◆ IotNetworkServerInfo_t

typedef _IotNetworkServerInfo_t IotNetworkServerInfo_t

The type used to represent network server info, configured with the type _IotNetworkServerInfo_t.

For the provided ports, _IotNetworkServerInfo_t will be automatically configured. For other ports, _IotNetworkServerInfo_t should be set in iot_config.h.

All of the provided ports configure this to IotNetworkServerInfo, which provides the necessary information to connect to a TCP peer. For other network protocols, this type should be set to an alternate structure as needed by the other protocol.

◆ IotNetworkCredentials_t

typedef _IotNetworkCredentials_t IotNetworkCredentials_t

The type used to represent network credentials, configured with the type _IotNetworkCredentials_t.

For the provided ports, _IotNetworkCredentials_t will be automatically configured. For other ports, _IotNetworkCredentials_t should be set in iot_config.h.

All of the provided ports configure this to IotNetworkCredentials, which provides the necessary information to connect to a TLS server over TCP. For other network protocols, this type should be set to an alternate structure as needed by the other protocol.

◆ IotNetworkConnection_t

typedef _IotNetworkConnection_t IotNetworkConnection_t

The type used to represent network connections, configured with the type _IotNetworkConnection_t.

For the provided ports, _IotNetworkConnection_t will be automatically configured. For other ports, _IotNetworkConnection_t should be set in iot_config.h.

Typedefs