Context Navigation

-                      r68e8f63
+                      r2341410c
 @itemize @bullet
 @item @code{sigaddset} -
 @item @code{sigdelset} -
 @item @code{sigfillset} -
 @item @code{sigismember} -
 @item @code{sigemptyset} -
 @item @code{sigaction} -
 @item @code{pthread_kill} -
 @item @code{sigprocmask} -
 @item @code{pthread_sigmask} -
 @item @code{kill} -
 @item @code{sigpending} -
 @item @code{sigsuspend} -
 @item @code{pause} -
 @item @code{sigwait} -
 @item @code{sigwaitinfo} -
 @item @code{sigtimedwait} -
 @item @code{sigqueue} -
 @item @code{alarm} -
+@item @code{sigaddset} - Add a Signal to a Signal Set
+@item @code{sigdelset} - Delete a Signal from a Signal Set
+@item @code{sigfillset} - Fill a Signal Set
+@item @code{sigismember} - Is Signal a Member of a Signal Set
+@item @code{sigemptyset} - Empty a Signal Set
+@item @code{sigaction} - Examine and Change Signal Action
+@item @code{pthread_kill} - Send a Signal to a Thread
+@item @code{sigprocmask} - Examine and Change Process Blocked Signals
+@item @code{pthread_sigmask} - Examine and Change Thread Blocked Signals
+@item @code{kill} - Send a Signal to a Process
+@item @code{sigpending} - Examine Pending Signals
+@item @code{sigsuspend} - Wait for a Signal
+@item @code{pause} - Suspend Process Execution
+@item @code{sigwait} - Synchronously Accept a Signal
+@item @code{sigwaitinfo} - Synchronously Accept a Signal
+@item @code{sigtimedwait} - Synchronously Accept a Signal with Timeout
+@item @code{sigqueue} - Queue a Signal to a Process
+@item @code{alarm} - Schedule Alarm
 @end itemize
 …
 @enumerate
 @item If the action for this signal is currently SIG_IGN, then the signal
 is simply ignored.
+@item If the action for this signal is currently @code{SIG_IGN},
+then the signal is simply ignored.
 @item If the currently executing thread has the signal unblocked, then
 …
 @item If any threads are currently blocked waiting for this signal
 (sigwait()), then the signal is delivered to the highest priority
+(@code{sigwait()}), then the signal is delivered to the highest priority
 thread waiting for this signal.
 …
 @item In the event the signal still can not be delivered, then it is left
 pending.  The first thread to unblock the signal (sigprocmask() or
+pthread_sigprocmask()) or to wait for this signal (sigwait()) will be
 the recipient of the signal.
+pending.  The first thread to unblock the signal (@code{sigprocmask()} or
+@code{pthread_sigprocmask()}) or to wait for this signal
+(@code{sigwait()}) will be the recipient of the signal.
 @end enumerate
 @section Operations
+There is currently no text in this section.
 @section Directives
 …
 @page
 @subsection sigaddset
+@subsection sigaddset - Add a Signal to a Signal Set
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigdelset
+This function adds the @code{signo} to the specified signal @code{set}.
+@subheading NOTES:
+@page
+@subsection sigdelset - Delete a Signal from a Signal Set
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigfillset
+This function deletes the @code{signo} to the specified signal @code{set}.
+@subheading NOTES:
+NONE
+@page
+@subsection sigfillset - Fill a Signal Set
 @subheading CALLING SEQUENCE:
 …
 @subheading STATUS CODES:
+@table @b
+@item EINVAL
+Invalid argument passed.
+@end table
+@subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigismember
+@table @b
+@item EINVAL
+Invalid argument passed.
+@end table
+@subheading DESCRIPTION:
+This function fills the specified signal @code{set} such that all
+signals are set.
+@subheading NOTES:
+NONE
+@page
+@subsection sigismember - Is Signal a Member of a Signal Set
 @subheading CALLING SEQUENCE:
 …
 @subheading STATUS CODES:
+@table @b
+@item EINVAL
+Invalid argument passed.
+@end table
+@subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigemptyset
+@table @b
+@item EINVAL
+Invalid argument passed.
+@end table
+@subheading DESCRIPTION:
+This function returns returns 1 if @code{signo} is a member of @code{set}
+and 0 otherwise.
+@subheading NOTES:
+NONE
+@page
+@subsection sigemptyset - Empty a Signal Set
 @subheading CALLING SEQUENCE:
 …
 @table @b
+@item EINVAL
+Invalid argument passed.
+@end table
+@subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigaction
+@item EINVAL
+Invalid argument passed.
+@end table
+@subheading DESCRIPTION:
+This function fills the specified signal @code{set} such that all
+signals are cleared.
+@subheading NOTES:
+NONE
+@page
+@subsection sigaction - Examine and Change Signal Action
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+This function is used to change the action taken by a process on
+receipt of the specfic signal @code{sig}.  The new action is
+specified by @code{act} and the previous action is returned
+via @code{oact}.
 @subheading NOTES:
 The signal number cannot be SIGKILL.
+@page
+@subsection pthread_kill
+@page
+@subsection pthread_kill - Send a Signal to a Thread
 @subheading CALLING SEQUENCE:
 …
 @subheading STATUS CODES:
+@table @b
+@table @b
 @item ESRCH
 The thread indicated by the parameter thread is invalid.
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigprocmask
+This functions sends the specified signal @code{sig} to @code{thread}.
+@subheading NOTES:
+NONE
+@page
+@subsection sigprocmask - Examine and Change Process Blocked Signals
 @subheading CALLING SEQUENCE:
 …
 @subheading STATUS CODES:
+@table @b
+@item EINVAL
+Invalid argument passed.
+@end table
+@subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection pthread_sigmask
+@table @b
+@item EINVAL
+Invalid argument passed.
+@end table
+@subheading DESCRIPTION:
+This function is used to alter the set of currently blocked signals
+on a process wide basis.  A blocked signal will not be received by the
+process.  The behavior of this function is dependent on the value of
+@code{how} which may be one of the following:
+@itemize @code
+@item SIG_BLOCK
+The set of blocked signals is set to the union of @code{set} and
+those signals currently blocked.
+@item SIG_UNBLOCK
+The signals specific in @code{set} are removed from the currently
+blocked set.
+@item SIG_SETMASK
+The set of currently blocked signals is set to @code{set}.
+@end itemize
+If @code{oset} is not @code{NULL}, then the set of blocked signals
+prior to this call is returned in @code{oset}.
+@subheading NOTES:
+It is not an error to unblock a signal which is not blocked.
+@page
+@subsection pthread_sigmask - Examine and Change Thread Blocked Signals
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection kill
+This function is used to alter the set of currently blocked signals
+for the calling thread.  A blocked signal will not be received by the
+process.  The behavior of this function is dependent on the value of
+@code{how} which may be one of the following:
+@table @code
+@item SIG_BLOCK
+The set of blocked signals is set to the union of @code{set} and
+those signals currently blocked.
+@item SIG_UNBLOCK
+The signals specific in @code{set} are removed from the currently
+blocked set.
+@item SIG_SETMASK
+The set of currently blocked signals is set to @code{set}.
+@end table
+If @code{oset} is not @code{NULL}, then the set of blocked signals
+prior to this call is returned in @code{oset}.
+@subheading NOTES:
+It is not an error to unblock a signal which is not blocked.
+@page
+@subsection kill - Send a Signal to a Process
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigpending
+This function sends the signal @code{sig} to the process @code{pid}.
+@subheading NOTES:
+NONE
+@page
+@subsection sigpending - Examine Pending Signals
 @subheading CALLING SEQUENCE:
 …
 @table @b
 @item EFAULT
 Invalid address for set.
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigsuspend
+This function allows the caller to examine the set of currently pending
+signals.  A pending signal is one which has been raised but is currently
+blocked.  The set of pending signals is returned in @code{set}.
+@subheading NOTES:
+NONE
+@page
+@subsection sigsuspend - Wait for a Signal
 @subheading CALLING SEQUENCE:
 …
 @subheading STATUS CODES:
 @table @b
 Returns -1 and sets errno.
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection pause
+This function temporarily replaces the signal mask for the process
+with that specified by @code{sigmask} and blocks the calling thread
+until the signal is raised.
+@subheading NOTES:
+NONE
+@page
+@subsection pause - Suspend Process Execution
 @subheading CALLING SEQUENCE:
 …
 @subheading STATUS CODES:
 @table @b
 Returns -1 and sets errno.
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigwait
+This function causes the calling thread to be blocked until the signal
+is received.
+@subheading NOTES:
+NONE
+@page
+@subsection sigwait - Synchronously Accept a Signal
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigwaitinfo
+This function selects a pending signal based on the set specified in
+@code{set}, atomically clears it from the set of pending signals, and
+returns the signal number for that signal in @code{sig}.
+@subheading NOTES:
+NONE
+@page
+@subsection sigwaitinfo - Synchronously Accept a Signal
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection sigtimedwait
+This function selects a pending signal based on the set specified in
+@code{set}, atomically clears it from the set of pending signals, and
+returns information about that signal in @code{info}.
+@subheading NOTES:
+NONE
+@page
+@subsection sigtimedwait - Synchronously Accept a Signal with Timeout
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+If timeout is NULL, then the thread will wait forever for the specified
+signal set.
+@page
+@subsection sigqueue
+This function selects a pending signal based on the set specified in
+@code{set}, atomically clears it from the set of pending signals, and
+returns information about that signal in @code{info}.  The calling thread
+will block up to @code{timeout} waiting for the signal to arrive.
+@subheading NOTES:
+If @code{timeout} is NULL, then the calling thread will wait forever for
+the specified signal set.
+@page
+@subsection sigqueue - Queue a Signal to a Process
 @subheading CALLING SEQUENCE:
 …
 @subheading DESCRIPTION:
+@subheading NOTES:
+@page
+@subsection alarm
+This function sends the signal specified by @code{signo} to the
+process @code{pid}
+@subheading NOTES:
+NONE
+@page
+@subsection alarm - Schedule Alarm
 @subheading CALLING SEQUENCE:
 …
 @subheading STATUS CODES:
+If there was a previous alarm() request with time remaining, then this routine
+returns the number of seconds until that outstanding alarm would have fired.
+If no previous alarm() request was outstanding, then zero is returned.
+@subheading DESCRIPTION:
+@subheading NOTES:
+This call always succeeds.
+@subheading DESCRIPTION:
+If there was a previous @code{alarm()} request with time remaining,
+then this routine returns the number of seconds until that outstanding
+alarm would have fired.  If no previous @code{alarm()} request was
+outstanding, then zero is returned.
+@subheading NOTES:
+NONE

Note: See TracChangeset for help on using the changeset viewer.

Context Navigation

Changeset 2341410c in rtems

Legend:

doc/new_chapters/signal.t

Download in other formats: