zwave_tx_incoming_frames Class Reference

#include <zwave_tx_incoming_frames.hpp>

Collaboration diagram for zwave_tx_incoming_frames:

Public Member Functions
sl_status_t	set_frames (zwave_node_id_t node_id, number_of_frames_t incoming_frames)
	Sets the number of expected frames from a NodeID. More...
sl_status_t	decrement_frames (zwave_node_id_t node_id)
	Decrements the number of expected frames from a NodeID. More...
number_of_frames_t	get_frames (zwave_node_id_t node_id)
	Gets the number of expected frames from a NodeID. More...
void	clear ()
	Clears the entire list of expected frames. More...
bool	empty () const
	Checks if we have any expected frame at all. More...

Private Member Functions
sl_status_t	insert (zwave_node_id_t node_id, number_of_frames_t incoming_frames)
	Helper function that inserts a NodeID / Frame pair in the frame list. More...

Private Attributes
priority_queue< zwave_tx_incoming_frame_item_t, ZWAVE_TX_INCOMING_FRAMES_BUFFER_SIZE, incoming_frame_item_compare >	frame_list

Member Function Documentation

clear()

void zwave_tx_incoming_frames::clear ( )

inline

Clears the entire list of expected frames.

Here is the call graph for this function:

decrement_frames()

sl_status_t zwave_tx_incoming_frames::decrement_frames ( zwave_node_id_t  node_id )

inline

Decrements the number of expected frames from a NodeID.

Parameters

node_id

NodeID to decrement the frames from

Returns

SL_STATUS_OK on success SL_STATUS_NOT_FOUND if nothing is to be done.

Here is the call graph for this function:

empty()

bool zwave_tx_incoming_frames::empty ( ) const

inline

Checks if we have any expected frame at all.

Returns

true if there are expected frames, false otherwise

Here is the call graph for this function:

get_frames()

number_of_frames_t zwave_tx_incoming_frames::get_frames ( zwave_node_id_t  node_id )

inline

Gets the number of expected frames from a NodeID.

Parameters

node_id

NodeID for which we expect to receive some frames

Returns

0 if no frame is expected, else the number of frames

Here is the call graph for this function:

insert()

sl_status_t zwave_tx_incoming_frames::insert ( zwave_node_id_t  node_id, number_of_frames_t  incoming_frames  )

inlineprivate

Helper function that inserts a NodeID / Frame pair in the frame list.

It is expected to verify manually that the NodeID does not exist in the frame list before invoking this function.

Parameters

node_id	NodeID to insert
incoming_frames	Number of frames to set for the NodeID.

Returns

SL_STATUS_OK on success, SL_STATUS_FAIL otherwise.

Here is the call graph for this function:

Here is the caller graph for this function:

set_frames()

sl_status_t zwave_tx_incoming_frames::set_frames ( zwave_node_id_t  node_id, number_of_frames_t  incoming_frames  )

inline

Sets the number of expected frames from a NodeID.

Parameters

node_id	NodeID to set the frames for
incoming_frames	Number of frames to set for the NodeID.

Returns

SL_STATUS_OK on success, SL_STATUS_FAIL on failure, SL_STATUS_NOT_FOUND if nothing is to be done.

Here is the call graph for this function:

Member Data Documentation

frame_list

priority_queue<zwave_tx_incoming_frame_item_t, ZWAVE_TX_INCOMING_FRAMES_BUFFER_SIZE, incoming_frame_item_compare> zwave_tx_incoming_frames::frame_list

private

---

The documentation for this class was generated from the following file:

• applications/zpc/components/zwave/zwave_tx/src/zwave_tx_incoming_frames.hpp