Platform API Reference
Platform portability layer
iot_network.h File Reference

Abstraction of network functions used by libraries in this SDK. More...

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>

Go to the source code of this file.

Data Structures

struct  IotNetworkInterface_t
 Represents the functions of a network stack. More...
 
struct  IotNetworkServerInfo_t
 Information on the remote server for connection setup. More...
 
struct  IotNetworkCredentials_t
 Contains the credentials necessary for connection setup. More...
 

Typedefs

typedef void(* IotNetworkReceiveCallback_t) (void *pConnection, void *pContext)
 Provide an asynchronous notification of incoming network data. More...
 

Enumerations

enum  IotNetworkError_t {
  IOT_NETWORK_SUCCESS = 0, IOT_NETWORK_FAILURE, IOT_NETWORK_BAD_PARAMETER, IOT_NETWORK_NO_MEMORY,
  IOT_NETWORK_SYSTEM_ERROR
}
 Return codes for network functions. More...
 

Detailed Description

Abstraction of network functions used by libraries in this SDK.

Typedef Documentation

◆ IotNetworkReceiveCallback_t

typedef void( * IotNetworkReceiveCallback_t) (void *pConnection, void *pContext)

Provide an asynchronous notification of incoming network data.

A function with this signature may be set with IotNetworkInterface_t::setReceiveCallback to be invoked when data is available on the network.

Parameters
[in]pConnectionThe connection on which data is available, defined by the network stack.
[in]pContextThe third argument passed to IotNetworkInterface_t::setReceiveCallback.