ZAF_Transport

Collaboration diagram for ZAF_Transport:

Topics
	ZAF_Transport_Endpoint
	ZAF_Transport_Multicast
	ZAF_Transport_Security

Data Structures
struct	zaf_tx_options_t

Typedefs
typedef void(*	zaf_tx_callback_t) (transmission_result_t *pTxResult)

Functions
bool	ZAF_transportSendDataAbort (void)
bool	zaf_transport_tx (const uint8_t *frame, uint8_t frame_length, zaf_tx_callback_t callback, zaf_tx_options_t *zaf_tx_options)
void	zaf_transport_rx_to_tx_options (RECEIVE_OPTIONS_TYPE_EX *rx_options, zaf_tx_options_t *tx_options)
void	zaf_transport_resume (void)
void	zaf_transport_pause (void)
void	zaf_transport_init (void)

Detailed Description

Typedef Documentation

zaf_tx_callback_t

typedef void(* zaf_tx_callback_t) (transmission_result_t *pTxResult)

Type used by the callbacks that are called once the tranmission is done

Function Documentation

zaf_transport_init()

void zaf_transport_init

(

void

)

Initializes the transport queue and needed variables

zaf_transport_pause()

void zaf_transport_pause

(

void

)

Pauses the transport queue

Remarks

This module is asynchronous therefore when using the pause functionality the user MUST be aware of deadlock situations

zaf_transport_resume()

void zaf_transport_resume

(

void

)

Resumes the transport queue

zaf_transport_rx_to_tx_options()

void zaf_transport_rx_to_tx_options	(	RECEIVE_OPTIONS_TYPE_EX *	rx_options,
		zaf_tx_options_t *	tx_options )

Converts the Receive Options to the Transmit Options needed by this module

Parameters

rx_options	A pointer to the receive options
tx_options	A pointer to the transmit options

zaf_transport_tx()

bool zaf_transport_tx	(	const uint8_t *	frame,
		uint8_t	frame_length,
		zaf_tx_callback_t	callback,
		zaf_tx_options_t *	zaf_tx_options )

Sends a frame to the controller which is to be transmitted

Parameters

frame	Pointer to the frame
frame_length	Frame length
callback	Callback which is called once the transmission is done
zaf_tx_options	Transmit options

Returns

true In case the module is capable enqueueing the frame

false In case the module is not capable enqueueing the frame

ZAF_transportSendDataAbort()

bool ZAF_transportSendDataAbort

(

void

)

Instructs Z-Wave protocol to Abort an Application initiated transmit if any in progress.