diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2012-12-21 09:50:15 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2012-12-21 15:40:27 +0100 |
commit | cbd07e4ce0ede36bacf6920bd594579e931b1bdd (patch) | |
tree | 716aba4b883d92fe7a8aab8338dc783ba04d812d /doc/user/chains.t | |
parent | bsp/gen83xx: Add GPR_1 to register map (diff) | |
download | rtems-cbd07e4ce0ede36bacf6920bd594579e931b1bdd.tar.bz2 |
score: Add rtems_chain_node_count_unprotected()
Diffstat (limited to 'doc/user/chains.t')
-rw-r--r-- | doc/user/chains.t | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/user/chains.t b/doc/user/chains.t index b422ee91ce..e5dffc24df 100644 --- a/doc/user/chains.t +++ b/doc/user/chains.t @@ -28,6 +28,7 @@ provided by RTEMS is: @item @code{@value{DIRPREFIX}chain_is_first} - Is the Node the first in the chain ? @item @code{@value{DIRPREFIX}chain_is_last} - Is the Node the last in the chain ? @item @code{@value{DIRPREFIX}chain_has_only_one_node} - Does the node have one node ? +@item @code{@value{DIRPREFIX}chain_node_count_unprotected} - Returns the node count of the chain (unprotected) @item @code{@value{DIRPREFIX}chain_is_head} - Is the node the head ? @item @code{@value{DIRPREFIX}chain_is_tail} - Is the node the tail ? @item @code{@value{DIRPREFIX}chain_extract} - Extract the node from the chain @@ -500,6 +501,33 @@ This function returns @code{true} if there is only one node on the chain and @c @c @page +@subsection Returns the node count of the chain (unprotected) + +@cindex chain only one node + +@subheading CALLING SEQUENCE: + +@ifset is-C +@findex @value{DIRPREFIX}chain_node_count_unprotected +@example +size_t @value{DIRPREFIX}chain_node_count_unprotected( + const @value{DIRPREFIX}chain_control *the_chain +); +@end example +@end ifset + +@subheading RETURNS + +This function returns the node count of the chain. + +@subheading DESCRIPTION: + +This function returns the node count of the chain. + +@c +@c +@c +@page @subsection Is this Node the Chain Head ? @cindex chain is node the head |