Changeset 2341410c in rtems


Ignore:
Timestamp:
Sep 29, 1998, 12:02:53 AM (21 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
241e4c7c
Parents:
68e8f63
Message:

Fleshed out considerably. This is almost a passable manual now.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/new_chapters/signal.t

    r68e8f63 r2341410c  
    1616
    1717@itemize @bullet
    18 @item @code{sigaddset} -
    19 @item @code{sigdelset} -
    20 @item @code{sigfillset} -
    21 @item @code{sigismember} -
    22 @item @code{sigemptyset} -
    23 @item @code{sigaction} -
    24 @item @code{pthread_kill} -
    25 @item @code{sigprocmask} -
    26 @item @code{pthread_sigmask} -
    27 @item @code{kill} -
    28 @item @code{sigpending} -
    29 @item @code{sigsuspend} -
    30 @item @code{pause} -
    31 @item @code{sigwait} -
    32 @item @code{sigwaitinfo} -
    33 @item @code{sigtimedwait} -
    34 @item @code{sigqueue} -
    35 @item @code{alarm} -
     18@item @code{sigaddset} - Add a Signal to a Signal Set
     19@item @code{sigdelset} - Delete a Signal from a Signal Set
     20@item @code{sigfillset} - Fill a Signal Set
     21@item @code{sigismember} - Is Signal a Member of a Signal Set
     22@item @code{sigemptyset} - Empty a Signal Set
     23@item @code{sigaction} - Examine and Change Signal Action
     24@item @code{pthread_kill} - Send a Signal to a Thread
     25@item @code{sigprocmask} - Examine and Change Process Blocked Signals
     26@item @code{pthread_sigmask} - Examine and Change Thread Blocked Signals
     27@item @code{kill} - Send a Signal to a Process
     28@item @code{sigpending} - Examine Pending Signals
     29@item @code{sigsuspend} - Wait for a Signal
     30@item @code{pause} - Suspend Process Execution
     31@item @code{sigwait} - Synchronously Accept a Signal
     32@item @code{sigwaitinfo} - Synchronously Accept a Signal
     33@item @code{sigtimedwait} - Synchronously Accept a Signal with Timeout
     34@item @code{sigqueue} - Queue a Signal to a Process
     35@item @code{alarm} - Schedule Alarm
    3636@end itemize
    3737
     
    4646
    4747@enumerate
    48 @item If the action for this signal is currently SIG_IGN, then the signal
    49 is simply ignored.
     48@item If the action for this signal is currently @code{SIG_IGN},
     49then the signal is simply ignored.
    5050
    5151@item If the currently executing thread has the signal unblocked, then
     
    5353
    5454@item If any threads are currently blocked waiting for this signal
    55 (sigwait()), then the signal is delivered to the highest priority
     55(@code{sigwait()}), then the signal is delivered to the highest priority
    5656thread waiting for this signal.
    5757
     
    6464
    6565@item In the event the signal still can not be delivered, then it is left
    66 pending.  The first thread to unblock the signal (sigprocmask() or
    67 pthread_sigprocmask()) or to wait for this signal (sigwait()) will be
    68 the recipient of the signal.
     66pending.  The first thread to unblock the signal (@code{sigprocmask()} or
     67@code{pthread_sigprocmask()}) or to wait for this signal
     68(@code{sigwait()}) will be the recipient of the signal.
    6969
    7070@end enumerate
    7171
    7272@section Operations
     73
     74There is currently no text in this section.
    7375
    7476@section Directives
     
    8082
    8183@page
    82 @subsection sigaddset
     84@subsection sigaddset - Add a Signal to a Signal Set
    8385
    8486@subheading CALLING SEQUENCE:
     
    103105@subheading DESCRIPTION:
    104106
    105 @subheading NOTES:
    106 
    107 @page
    108 @subsection sigdelset
     107This function adds the @code{signo} to the specified signal @code{set}.
     108
     109@subheading NOTES:
     110
     111@page
     112@subsection sigdelset - Delete a Signal from a Signal Set
    109113
    110114@subheading CALLING SEQUENCE:
     
    129133@subheading DESCRIPTION:
    130134
    131 @subheading NOTES:
    132 
    133 @page
    134 @subsection sigfillset
     135This function deletes the @code{signo} to the specified signal @code{set}.
     136
     137@subheading NOTES:
     138
     139NONE
     140
     141@page
     142@subsection sigfillset - Fill a Signal Set
    135143
    136144@subheading CALLING SEQUENCE:
     
    145153
    146154@subheading STATUS CODES:
    147 @table @b
    148 @item EINVAL
    149 Invalid argument passed.
    150 
    151 @end table
    152 
    153 @subheading DESCRIPTION:
    154 
    155 @subheading NOTES:
    156 
    157 @page
    158 @subsection sigismember
     155
     156@table @b
     157
     158@item EINVAL
     159Invalid argument passed.
     160
     161@end table
     162
     163@subheading DESCRIPTION:
     164
     165This function fills the specified signal @code{set} such that all
     166signals are set.
     167
     168@subheading NOTES:
     169
     170NONE
     171
     172@page
     173@subsection sigismember - Is Signal a Member of a Signal Set
    159174
    160175@subheading CALLING SEQUENCE:
     
    170185
    171186@subheading STATUS CODES:
    172 @table @b
    173 @item EINVAL
    174 Invalid argument passed.
    175 
    176 @end table
    177 
    178 @subheading DESCRIPTION:
    179 
    180 @subheading NOTES:
    181 
    182 @page
    183 @subsection sigemptyset
     187
     188@table @b
     189
     190@item EINVAL
     191Invalid argument passed.
     192
     193@end table
     194
     195@subheading DESCRIPTION:
     196
     197This function returns returns 1 if @code{signo} is a member of @code{set}
     198and 0 otherwise.
     199
     200@subheading NOTES:
     201
     202NONE
     203
     204@page
     205@subsection sigemptyset - Empty a Signal Set
    184206
    185207@subheading CALLING SEQUENCE:
     
    196218
    197219@table @b
    198 @item EINVAL
    199 Invalid argument passed.
    200 
    201 @end table
    202 
    203 @subheading DESCRIPTION:
    204 
    205 @subheading NOTES:
    206 
    207 @page
    208 @subsection sigaction
     220
     221@item EINVAL
     222Invalid argument passed.
     223
     224@end table
     225
     226@subheading DESCRIPTION:
     227
     228This function fills the specified signal @code{set} such that all
     229signals are cleared.
     230
     231@subheading NOTES:
     232
     233NONE
     234
     235@page
     236@subsection sigaction - Examine and Change Signal Action
    209237
    210238@subheading CALLING SEQUENCE:
     
    233261@subheading DESCRIPTION:
    234262
     263This function is used to change the action taken by a process on
     264receipt of the specfic signal @code{sig}.  The new action is
     265specified by @code{act} and the previous action is returned
     266via @code{oact}.
     267
    235268@subheading NOTES:
    236269
    237270The signal number cannot be SIGKILL.
    238 @page
    239 @subsection pthread_kill
     271
     272@page
     273@subsection pthread_kill - Send a Signal to a Thread
    240274
    241275@subheading CALLING SEQUENCE:
     
    251285
    252286@subheading STATUS CODES:
    253 @table @b
     287
     288@table @b
     289
    254290@item ESRCH
    255291The thread indicated by the parameter thread is invalid.
     
    262298@subheading DESCRIPTION:
    263299
    264 @subheading NOTES:
    265 
    266 @page
    267 @subsection sigprocmask
     300This functions sends the specified signal @code{sig} to @code{thread}.
     301
     302@subheading NOTES:
     303
     304NONE
     305
     306@page
     307@subsection sigprocmask - Examine and Change Process Blocked Signals
    268308 
    269309@subheading CALLING SEQUENCE:
     
    280320 
    281321@subheading STATUS CODES:
    282 @table @b
    283 @item EINVAL
    284 Invalid argument passed.
    285  
    286 @end table
    287  
    288 @subheading DESCRIPTION:
    289  
    290 @subheading NOTES:
    291  
    292 
    293 @page
    294 @subsection pthread_sigmask
     322
     323@table @b
     324
     325@item EINVAL
     326Invalid argument passed.
     327 
     328@end table
     329 
     330@subheading DESCRIPTION:
     331 
     332This function is used to alter the set of currently blocked signals
     333on a process wide basis.  A blocked signal will not be received by the
     334process.  The behavior of this function is dependent on the value of
     335@code{how} which may be one of the following:
     336
     337@itemize @code
     338@item SIG_BLOCK
     339The set of blocked signals is set to the union of @code{set} and
     340those signals currently blocked.
     341
     342@item SIG_UNBLOCK
     343The signals specific in @code{set} are removed from the currently
     344blocked set.
     345
     346@item SIG_SETMASK
     347The set of currently blocked signals is set to @code{set}.
     348
     349@end itemize
     350
     351If @code{oset} is not @code{NULL}, then the set of blocked signals
     352prior to this call is returned in @code{oset}.
     353
     354@subheading NOTES:
     355
     356It is not an error to unblock a signal which is not blocked.
     357
     358@page
     359@subsection pthread_sigmask - Examine and Change Thread Blocked Signals
    295360
    296361@subheading CALLING SEQUENCE:
     
    315380@subheading DESCRIPTION:
    316381
    317 @subheading NOTES:
    318 
    319 
    320 @page
    321 @subsection kill
     382This function is used to alter the set of currently blocked signals
     383for the calling thread.  A blocked signal will not be received by the
     384process.  The behavior of this function is dependent on the value of
     385@code{how} which may be one of the following:
     386
     387@table @code
     388@item SIG_BLOCK
     389The set of blocked signals is set to the union of @code{set} and
     390those signals currently blocked.
     391
     392@item SIG_UNBLOCK
     393The signals specific in @code{set} are removed from the currently
     394blocked set.
     395
     396@item SIG_SETMASK
     397The set of currently blocked signals is set to @code{set}.
     398
     399@end table
     400
     401If @code{oset} is not @code{NULL}, then the set of blocked signals
     402prior to this call is returned in @code{oset}.
     403
     404@subheading NOTES:
     405
     406It is not an error to unblock a signal which is not blocked.
     407
     408
     409@page
     410@subsection kill - Send a Signal to a Process
    322411
    323412@subheading CALLING SEQUENCE:
     
    348437@subheading DESCRIPTION:
    349438
    350 @subheading NOTES:
    351 
    352  
    353 @page
    354 @subsection sigpending
     439This function sends the signal @code{sig} to the process @code{pid}.
     440
     441@subheading NOTES:
     442
     443NONE
     444 
     445@page
     446@subsection sigpending - Examine Pending Signals
    355447 
    356448@subheading CALLING SEQUENCE:
     
    369461 
    370462@table @b
     463
    371464@item EFAULT
    372465Invalid address for set.
     
    375468
    376469@subheading DESCRIPTION:
    377  
    378 @subheading NOTES:
    379 
    380 @page
    381 @subsection sigsuspend
     470
     471This function allows the caller to examine the set of currently pending
     472signals.  A pending signal is one which has been raised but is currently
     473blocked.  The set of pending signals is returned in @code{set}.
     474 
     475@subheading NOTES:
     476
     477NONE
     478
     479@page
     480@subsection sigsuspend - Wait for a Signal
    382481 
    383482@subheading CALLING SEQUENCE:
     
    392491 
    393492@subheading STATUS CODES:
     493
    394494@table @b
    395495Returns -1 and sets errno.
     
    401501 
    402502@subheading DESCRIPTION:
    403  
    404 @subheading NOTES:
    405 
    406 @page
    407 @subsection pause
     503
     504This function temporarily replaces the signal mask for the process
     505with that specified by @code{sigmask} and blocks the calling thread
     506until the signal is raised.
     507 
     508@subheading NOTES:
     509
     510NONE
     511
     512@page
     513@subsection pause - Suspend Process Execution
    408514 
    409515@subheading CALLING SEQUENCE:
     
    416522 
    417523@subheading STATUS CODES:
     524
    418525@table @b
    419526Returns -1 and sets errno.
     
    425532 
    426533@subheading DESCRIPTION:
    427  
    428 @subheading NOTES:
    429  
    430 @page
    431 @subsection sigwait
     534
     535This function causes the calling thread to be blocked until the signal
     536is received.
     537 
     538@subheading NOTES:
     539
     540NONE
     541 
     542@page
     543@subsection sigwait - Synchronously Accept a Signal
    432544
    433545@subheading CALLING SEQUENCE:
     
    454566@subheading DESCRIPTION:
    455567
    456 @subheading NOTES:
    457 
    458 @page
    459 @subsection sigwaitinfo
     568This function selects a pending signal based on the set specified in
     569@code{set}, atomically clears it from the set of pending signals, and
     570returns the signal number for that signal in @code{sig}.
     571
     572
     573@subheading NOTES:
     574
     575NONE
     576
     577@page
     578@subsection sigwaitinfo - Synchronously Accept a Signal
    460579 
    461580@subheading CALLING SEQUENCE:
     
    479598@subheading DESCRIPTION:
    480599 
    481 @subheading NOTES:
    482 
    483 @page
    484 @subsection sigtimedwait
     600This function selects a pending signal based on the set specified in
     601@code{set}, atomically clears it from the set of pending signals, and
     602returns information about that signal in @code{info}.
     603
     604@subheading NOTES:
     605
     606NONE
     607
     608@page
     609@subsection sigtimedwait - Synchronously Accept a Signal with Timeout
    485610 
    486611@subheading CALLING SEQUENCE:
     
    511636@subheading DESCRIPTION:
    512637 
    513 @subheading NOTES:
    514 
    515 If timeout is NULL, then the thread will wait forever for the specified
    516 signal set.
    517 
    518 @page
    519 @subsection sigqueue
     638This function selects a pending signal based on the set specified in
     639@code{set}, atomically clears it from the set of pending signals, and
     640returns information about that signal in @code{info}.  The calling thread
     641will block up to @code{timeout} waiting for the signal to arrive.
     642
     643@subheading NOTES:
     644
     645If @code{timeout} is NULL, then the calling thread will wait forever for
     646the specified signal set.
     647
     648@page
     649@subsection sigqueue - Queue a Signal to a Process
    520650 
    521651@subheading CALLING SEQUENCE:
     
    554684 
    555685@subheading DESCRIPTION:
    556  
    557 @subheading NOTES:
    558 
    559 
    560 @page
    561 @subsection alarm
     686
     687This function sends the signal specified by @code{signo} to the
     688process @code{pid}
     689 
     690@subheading NOTES:
     691
     692NONE
     693
     694@page
     695@subsection alarm - Schedule Alarm
    562696 
    563697@subheading CALLING SEQUENCE:
     
    573707@subheading STATUS CODES:
    574708
    575 If there was a previous alarm() request with time remaining, then this routine
    576 returns the number of seconds until that outstanding alarm would have fired.
    577 If no previous alarm() request was outstanding, then zero is returned.
    578  
    579 @subheading DESCRIPTION:
    580  
    581 @subheading NOTES:
    582 
    583 
     709This call always succeeds.
     710 
     711@subheading DESCRIPTION:
     712 
     713If there was a previous @code{alarm()} request with time remaining,
     714then this routine returns the number of seconds until that outstanding
     715alarm would have fired.  If no previous @code{alarm()} request was
     716outstanding, then zero is returned.
     717
     718@subheading NOTES:
     719
     720NONE
Note: See TracChangeset for help on using the changeset viewer.