%
% Copyright 2014, General Dynamics C4 Systems
%
% This software may be distributed and modified according to the terms of
% the GNU General Public License version 2. Note that NO WARRANTY is provided.
% See "LICENSE_GPLv2.txt" for details.
%
% @TAG(GD_GPL)
%

\apidoc
{sel4_poll}
{Poll}
{Perform a non-blocking recv on a notification object.}
{static inline void seL4\_Poll}
{
\param{seL4\_CPtr}{src}{\invokedcapdesc}
\param{seL4\_Word*}{sender}{\senderdesc}
}
{\noret}
{
This is not a proper system call
known by the kernel. Rather, it is a convenience
wrapper provided by the seL4 userland library which calls
\apifunc{seL4\_NBRecv}{sel4_nbrecv}. It is
useful for doing a non-blocking wait on a notification.

See the description of \apifunc{seL4\_NBRecv}{sel4_nbrecv} in \autoref{sec:sys_nbrecv}
}
