Tunneling Client#
Callbacks for Tunneling Client Component.
#
Callbacks
Tunnel opened.
Data received.
Data error.
Tunnel closed.
Transfer data failure.
emberAfPluginTunnelingClientTunnelOpenedCallback#
void emberAfPluginTunnelingClientTunnelOpenedCallback (uint8_t tunnelIndex, EmberAfPluginTunnelingClientStatus tunnelStatus, uint16_t maximumIncomingTransferSize)
Tunnel opened.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | tunnelIndex | The index of the tunnel that has been opened. Ver.: always |
| EmberAfPluginTunnelingClientStatus | N/A | tunnelStatus | The status of the request. Ver.: always |
| uint16_t | N/A | maximumIncomingTransferSize | The maximum incoming transfer size of the server. Ver.: always |
This function is called by the Tunneling client plugin whenever a tunnel is opened. Clients may open tunnels by sending a Request Tunnel command.
emberAfPluginTunnelingClientDataReceivedCallback#
void emberAfPluginTunnelingClientDataReceivedCallback (uint8_t tunnelIndex, uint8_t * data, uint16_t dataLen)
Data received.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | tunnelIndex | The index of the tunnel through which the data was received. Ver.: always |
| uint8_t * | N/A | data | Buffer containing the raw octets of the data. Ver.: always |
| uint16_t | N/A | dataLen | The length in octets of the data. Ver.: always |
This function is called by the Tunneling client plugin whenever data is received from a server through a tunnel.
emberAfPluginTunnelingClientDataErrorCallback#
void emberAfPluginTunnelingClientDataErrorCallback (uint8_t tunnelIndex, EmberAfTunnelingTransferDataStatus transferDataStatus)
Data error.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | tunnelIndex | The index of the tunnel on which this data error occurred. Ver.: always |
| EmberAfTunnelingTransferDataStatus | N/A | transferDataStatus | The error that occurred. Ver.: always |
This function is called by the Tunneling client plugin whenever a data error occurs on a tunnel. Errors occur if a device attempts to send data on tunnel that is no longer active or if the tunneling does not belong to the device.
emberAfPluginTunnelingClientTunnelClosedCallback#
void emberAfPluginTunnelingClientTunnelClosedCallback (uint8_t tunnelIndex)
Tunnel closed.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | tunnelIndex | The index of the tunnel that has been closed. Ver.: always |
This function is called by the Tunneling client plugin whenever a server sends a notification that it preemptively closed an inactive tunnel. Servers are not required to notify clients of tunnel closures, so applications cannot rely on this callback being called for all tunnels.
emberAfPluginTunnelingClientTransferDataFailureCallback#
void emberAfPluginTunnelingClientTransferDataFailureCallback (uint16_t indexOfDestination, EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status)
Transfer data failure.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | indexOfDestination | The index or destination address of the TransferData command. Ver.: always |
| EmberApsFrame * | N/A | apsFrame | The ::EmberApsFrame of the command. Ver.: always |
| uint16_t | N/A | msgLen | The length of the payload sent in the command. Ver.: always |
| uint8_t * | N/A | message | The payload that was sent in the command. Ver.: always |
| EmberStatus | N/A | status | The non-success status code from the transmission of the command. Ver.: always |
This function is called when a TransferData command fails to be sent to the intended destination.