rtl-chain-iterator.h File Reference

RTEMS Run-Time Linker Chain Iterator. More...

#include <rtems/chain.h>

Go to the source code of this file.

Typedefs
typedef bool(*	rtems_chain_iterator) (rtems_chain_node *node, void *data)

Functions
bool	rtems_rtl_chain_iterate (rtems_chain_control *chain, rtems_chain_iterator iterator, void *data)
int	rtems_rtl_chain_count (rtems_chain_control *chain)

Detailed Description

RTEMS Run-Time Linker Chain Iterator.

Typedef Documentation

rtems_chain_iterator

typedef bool(* rtems_chain_iterator) (rtems_chain_node *node, void *data)

Chain iterator handler.

Function Documentation

rtems_rtl_chain_count()

int rtems_rtl_chain_count

(

rtems_chain_control *

chain

)

Count the number of nodes on the chain.

Parameters

chain

The chain to count the nodes of.

Returns

int The number of nodes.

rtems_rtl_chain_iterate()

bool rtems_rtl_chain_iterate	(	rtems_chain_control *	chain,
		rtems_chain_iterator	iterator,
		void *	data
	)

Iterate a chain of nodes invoking the iterator handler. Supply a data pointer the iterator moves data between the invoker and the iterator.

The iterator allows removal of the node from the chain.

Parameters

chain	The chain of nodes to iterator over.
iterator	The iterator handler called once for each node.
data	Pointer to the data used by the iterator.

Return values

true	The whole chain was iterated over.
false	The iterator returned false.