Trident IoT Z-Wave SDK
 
Loading...
Searching...
No Matches
ZAF_Transport_Multicast
+ Collaboration diagram for ZAF_Transport_Multicast:

Enumerations

enum  ETRANSPORT_MULTICAST_STATUS {
  ETRANSPORTMULTICAST_FAILED = 0 ,
  ETRANSPORTMULTICAST_ADDED_TO_QUEUE = 1
}
 

Functions

enum ETRANSPORT_MULTICAST_STATUS ZW_TransportMulticast_SendRequest (const uint8_t *const p_data, uint8_t data_length, uint8_t fSupervisionEnable, TRANSMIT_OPTIONS_TYPE_EX *p_nodelist, ZAF_TX_Callback_t p_callback)
 
void ZW_TransportMulticast_clearTimeout (void)
 
void ZW_TransportMulticast_init (void)
 Initializes the Tx Buffer.
 

Detailed Description

Enumeration Type Documentation

◆ ETRANSPORT_MULTICAST_STATUS

Enumerator
ETRANSPORTMULTICAST_FAILED 
ETRANSPORTMULTICAST_ADDED_TO_QUEUE 

Function Documentation

◆ ZW_TransportMulticast_clearTimeout()

void ZW_TransportMulticast_clearTimeout ( void )

◆ ZW_TransportMulticast_init()

void ZW_TransportMulticast_init ( void )

Initializes the Tx Buffer.

◆ ZW_TransportMulticast_SendRequest()

enum ETRANSPORT_MULTICAST_STATUS ZW_TransportMulticast_SendRequest ( const uint8_t *const p_data,
uint8_t data_length,
uint8_t fSupervisionEnable,
TRANSMIT_OPTIONS_TYPE_EX * p_nodelist,
ZAF_TX_Callback_t p_callback )

Initiates transmission of a frame and will handle multi channel and multicast transmissions.

If the node has associations to multiple endpoints of the same node, this function will transmit one multi channel encapsulated frame that addresses the associated endpoints.

If the node is included using S2 and has more than one non-endpoint association, this function will transmit an S2 multicast (broadcast) frame addressing those associations followed by singlecast follow-up frames.

If the node is included using S0 there will be no multicast since S0 does not support multicast.

If the node is non-securely included and has more than one non-endpoint association, this function will transmit a non-secure multicast followed by singlecast follow-up frames.

Parameters
[in]p_dataPointer to data.
[in]data_lengthLength of data in bytes.
[in]fSupervisionEnableEnable Supervision encapsulation if set to true.
[in]p_nodelistPointer to a list of nodes.
[in]p_callbackPointer to a callback function which is called for each transmission to a node.
Returns
Returns status of transmission.