Tunneling Client#

Callbacks for Tunneling Client Component.

#

Callbacks

void
emberAfPluginTunnelingClientTunnelOpenedCallback(uint8_t tunnelIndex, EmberAfPluginTunnelingClientStatus tunnelStatus, uint16_t maximumIncomingTransferSize)

Tunnel opened.

void
emberAfPluginTunnelingClientDataReceivedCallback(uint8_t tunnelIndex, uint8_t *data, uint16_t dataLen)

Data received.

void
emberAfPluginTunnelingClientDataErrorCallback(uint8_t tunnelIndex, EmberAfTunnelingTransferDataStatus transferDataStatus)

Data error.

void

Tunnel closed.

void
emberAfPluginTunnelingClientTransferDataFailureCallback(uint16_t indexOfDestination, EmberApsFrame *apsFrame, uint16_t msgLen, uint8_t *message, EmberStatus status)

Transfer data failure.

undefined Documentation#

emberAfPluginTunnelingClientTunnelOpenedCallback#

void emberAfPluginTunnelingClientTunnelOpenedCallback (uint8_t tunnelIndex, EmberAfPluginTunnelingClientStatus tunnelStatus, uint16_t maximumIncomingTransferSize)

Tunnel opened.

Parameters
N/AtunnelIndex

The index of the tunnel that has been opened. Ver.: always

N/AtunnelStatus

The status of the request. Ver.: always

N/AmaximumIncomingTransferSize

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.


Definition at line 150 of file app/framework/plugin/tunneling-client/tunneling-client.h

emberAfPluginTunnelingClientDataReceivedCallback#

void emberAfPluginTunnelingClientDataReceivedCallback (uint8_t tunnelIndex, uint8_t * data, uint16_t dataLen)

Data received.

Parameters
N/AtunnelIndex

The index of the tunnel through which the data was received. Ver.: always

N/Adata

Buffer containing the raw octets of the data. Ver.: always

N/AdataLen

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.


Definition at line 163 of file app/framework/plugin/tunneling-client/tunneling-client.h

emberAfPluginTunnelingClientDataErrorCallback#

void emberAfPluginTunnelingClientDataErrorCallback (uint8_t tunnelIndex, EmberAfTunnelingTransferDataStatus transferDataStatus)

Data error.

Parameters
N/AtunnelIndex

The index of the tunnel on which this data error occurred. Ver.: always

N/AtransferDataStatus

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.


Definition at line 176 of file app/framework/plugin/tunneling-client/tunneling-client.h

emberAfPluginTunnelingClientTunnelClosedCallback#

void emberAfPluginTunnelingClientTunnelClosedCallback (uint8_t tunnelIndex)

Tunnel closed.

Parameters
N/AtunnelIndex

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.


Definition at line 188 of file app/framework/plugin/tunneling-client/tunneling-client.h

emberAfPluginTunnelingClientTransferDataFailureCallback#

void emberAfPluginTunnelingClientTransferDataFailureCallback (uint16_t indexOfDestination, EmberApsFrame * apsFrame, uint16_t msgLen, uint8_t * message, EmberStatus status)

Transfer data failure.

Parameters
N/AindexOfDestination

The index or destination address of the TransferData command. Ver.: always

N/AapsFrame

The ::EmberApsFrame of the command. Ver.: always

N/AmsgLen

The length of the payload sent in the command. Ver.: always

N/Amessage

The payload that was sent in the command. Ver.: always

N/Astatus

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.


Definition at line 202 of file app/framework/plugin/tunneling-client/tunneling-client.h