Azure IoT middleware for FreeRTOS
Data Structures | Typedefs
azure_iot_transport_interface.h File Reference

Transport interface definition to send and receive data over the network. More...

#include <stdint.h>
#include <stddef.h>

Go to the source code of this file.

Data Structures

struct  AzureIoTTransportInterface
 The transport layer interface. More...
 

Typedefs

typedef int32_t(* AzureIoTTransportRecv_t) (struct NetworkContext *pxNetworkContext, void *pvBuffer, size_t xBytesToRecv)
 User defined function for receiving data on the network. More...
 
typedef int32_t(* AzureIoTTransportSend_t) (struct NetworkContext *pxNetworkContext, const void *pvBuffer, size_t xBytesToSend)
 User defined function for sending data on the network. More...
 
typedef struct AzureIoTTransportInterface AzureIoTTransportInterface_t
 The transport layer interface.
 

Detailed Description

Transport interface definition to send and receive data over the network.

Typedef Documentation

◆ AzureIoTTransportRecv_t

typedef int32_t( * AzureIoTTransportRecv_t) (struct NetworkContext *pxNetworkContext, void *pvBuffer, size_t xBytesToRecv)

User defined function for receiving data on the network.

Parameters
[in]pxNetworkContextImplementation-defined network context.
[in]pvBufferBuffer to receive the data into.
[in]xBytesToRecvNumber of bytes requested from the network.
Returns
The number of bytes received or a negative error code.

◆ AzureIoTTransportSend_t

typedef int32_t( * AzureIoTTransportSend_t) (struct NetworkContext *pxNetworkContext, const void *pvBuffer, size_t xBytesToSend)

User defined function for sending data on the network.

Parameters
[in]pxNetworkContextImplementation-defined network context.
[in]pvBufferBuffer containing the bytes to send over the network stack.
[in]xBytesToSendNumber of bytes to send over the network.
Returns
The number of bytes sent or a negative error code.