Changeset 2341410c in rtems
- Timestamp:
- 09/29/98 00:02:53 (24 years ago)
- Branches:
- 4.10, 4.11, 4.8, 4.9, 5, master
- Children:
- 241e4c7c
- Parents:
- 68e8f63
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/new_chapters/signal.t
r68e8f63 r2341410c 16 16 17 17 @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 36 36 @end itemize 37 37 … … 46 46 47 47 @enumerate 48 @item If the action for this signal is currently SIG_IGN, then the signal49 is simply ignored.48 @item If the action for this signal is currently @code{SIG_IGN}, 49 then the signal is simply ignored. 50 50 51 51 @item If the currently executing thread has the signal unblocked, then … … 53 53 54 54 @item If any threads are currently blocked waiting for this signal 55 ( sigwait()), then the signal is delivered to the highest priority55 (@code{sigwait()}), then the signal is delivered to the highest priority 56 56 thread waiting for this signal. 57 57 … … 64 64 65 65 @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()or67 pthread_sigprocmask()) or to wait for this signal (sigwait()) will be 68 the recipient of the signal.66 pending. 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. 69 69 70 70 @end enumerate 71 71 72 72 @section Operations 73 74 There is currently no text in this section. 73 75 74 76 @section Directives … … 80 82 81 83 @page 82 @subsection sigaddset 84 @subsection sigaddset - Add a Signal to a Signal Set 83 85 84 86 @subheading CALLING SEQUENCE: … … 103 105 @subheading DESCRIPTION: 104 106 105 @subheading NOTES: 106 107 @page 108 @subsection sigdelset 107 This 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 109 113 110 114 @subheading CALLING SEQUENCE: … … 129 133 @subheading DESCRIPTION: 130 134 131 @subheading NOTES: 132 133 @page 134 @subsection sigfillset 135 This function deletes the @code{signo} to the specified signal @code{set}. 136 137 @subheading NOTES: 138 139 NONE 140 141 @page 142 @subsection sigfillset - Fill a Signal Set 135 143 136 144 @subheading CALLING SEQUENCE: … … 145 153 146 154 @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 159 Invalid argument passed. 160 161 @end table 162 163 @subheading DESCRIPTION: 164 165 This function fills the specified signal @code{set} such that all 166 signals are set. 167 168 @subheading NOTES: 169 170 NONE 171 172 @page 173 @subsection sigismember - Is Signal a Member of a Signal Set 159 174 160 175 @subheading CALLING SEQUENCE: … … 170 185 171 186 @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 191 Invalid argument passed. 192 193 @end table 194 195 @subheading DESCRIPTION: 196 197 This function returns returns 1 if @code{signo} is a member of @code{set} 198 and 0 otherwise. 199 200 @subheading NOTES: 201 202 NONE 203 204 @page 205 @subsection sigemptyset - Empty a Signal Set 184 206 185 207 @subheading CALLING SEQUENCE: … … 196 218 197 219 @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 222 Invalid argument passed. 223 224 @end table 225 226 @subheading DESCRIPTION: 227 228 This function fills the specified signal @code{set} such that all 229 signals are cleared. 230 231 @subheading NOTES: 232 233 NONE 234 235 @page 236 @subsection sigaction - Examine and Change Signal Action 209 237 210 238 @subheading CALLING SEQUENCE: … … 233 261 @subheading DESCRIPTION: 234 262 263 This function is used to change the action taken by a process on 264 receipt of the specfic signal @code{sig}. The new action is 265 specified by @code{act} and the previous action is returned 266 via @code{oact}. 267 235 268 @subheading NOTES: 236 269 237 270 The signal number cannot be SIGKILL. 238 @page 239 @subsection pthread_kill 271 272 @page 273 @subsection pthread_kill - Send a Signal to a Thread 240 274 241 275 @subheading CALLING SEQUENCE: … … 251 285 252 286 @subheading STATUS CODES: 253 @table @b 287 288 @table @b 289 254 290 @item ESRCH 255 291 The thread indicated by the parameter thread is invalid. … … 262 298 @subheading DESCRIPTION: 263 299 264 @subheading NOTES: 265 266 @page 267 @subsection sigprocmask 300 This functions sends the specified signal @code{sig} to @code{thread}. 301 302 @subheading NOTES: 303 304 NONE 305 306 @page 307 @subsection sigprocmask - Examine and Change Process Blocked Signals 268 308 269 309 @subheading CALLING SEQUENCE: … … 280 320 281 321 @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 326 Invalid argument passed. 327 328 @end table 329 330 @subheading DESCRIPTION: 331 332 This function is used to alter the set of currently blocked signals 333 on a process wide basis. A blocked signal will not be received by the 334 process. 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 339 The set of blocked signals is set to the union of @code{set} and 340 those signals currently blocked. 341 342 @item SIG_UNBLOCK 343 The signals specific in @code{set} are removed from the currently 344 blocked set. 345 346 @item SIG_SETMASK 347 The set of currently blocked signals is set to @code{set}. 348 349 @end itemize 350 351 If @code{oset} is not @code{NULL}, then the set of blocked signals 352 prior to this call is returned in @code{oset}. 353 354 @subheading NOTES: 355 356 It 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 295 360 296 361 @subheading CALLING SEQUENCE: … … 315 380 @subheading DESCRIPTION: 316 381 317 @subheading NOTES: 318 319 320 @page 321 @subsection kill 382 This function is used to alter the set of currently blocked signals 383 for the calling thread. A blocked signal will not be received by the 384 process. 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 389 The set of blocked signals is set to the union of @code{set} and 390 those signals currently blocked. 391 392 @item SIG_UNBLOCK 393 The signals specific in @code{set} are removed from the currently 394 blocked set. 395 396 @item SIG_SETMASK 397 The set of currently blocked signals is set to @code{set}. 398 399 @end table 400 401 If @code{oset} is not @code{NULL}, then the set of blocked signals 402 prior to this call is returned in @code{oset}. 403 404 @subheading NOTES: 405 406 It 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 322 411 323 412 @subheading CALLING SEQUENCE: … … 348 437 @subheading DESCRIPTION: 349 438 350 @subheading NOTES: 351 352 353 @page 354 @subsection sigpending 439 This function sends the signal @code{sig} to the process @code{pid}. 440 441 @subheading NOTES: 442 443 NONE 444 445 @page 446 @subsection sigpending - Examine Pending Signals 355 447 356 448 @subheading CALLING SEQUENCE: … … 369 461 370 462 @table @b 463 371 464 @item EFAULT 372 465 Invalid address for set. … … 375 468 376 469 @subheading DESCRIPTION: 377 378 @subheading NOTES: 379 380 @page 381 @subsection sigsuspend 470 471 This function allows the caller to examine the set of currently pending 472 signals. A pending signal is one which has been raised but is currently 473 blocked. The set of pending signals is returned in @code{set}. 474 475 @subheading NOTES: 476 477 NONE 478 479 @page 480 @subsection sigsuspend - Wait for a Signal 382 481 383 482 @subheading CALLING SEQUENCE: … … 392 491 393 492 @subheading STATUS CODES: 493 394 494 @table @b 395 495 Returns -1 and sets errno. … … 401 501 402 502 @subheading DESCRIPTION: 403 404 @subheading NOTES: 405 406 @page 407 @subsection pause 503 504 This function temporarily replaces the signal mask for the process 505 with that specified by @code{sigmask} and blocks the calling thread 506 until the signal is raised. 507 508 @subheading NOTES: 509 510 NONE 511 512 @page 513 @subsection pause - Suspend Process Execution 408 514 409 515 @subheading CALLING SEQUENCE: … … 416 522 417 523 @subheading STATUS CODES: 524 418 525 @table @b 419 526 Returns -1 and sets errno. … … 425 532 426 533 @subheading DESCRIPTION: 427 428 @subheading NOTES: 429 430 @page 431 @subsection sigwait 534 535 This function causes the calling thread to be blocked until the signal 536 is received. 537 538 @subheading NOTES: 539 540 NONE 541 542 @page 543 @subsection sigwait - Synchronously Accept a Signal 432 544 433 545 @subheading CALLING SEQUENCE: … … 454 566 @subheading DESCRIPTION: 455 567 456 @subheading NOTES: 457 458 @page 459 @subsection sigwaitinfo 568 This function selects a pending signal based on the set specified in 569 @code{set}, atomically clears it from the set of pending signals, and 570 returns the signal number for that signal in @code{sig}. 571 572 573 @subheading NOTES: 574 575 NONE 576 577 @page 578 @subsection sigwaitinfo - Synchronously Accept a Signal 460 579 461 580 @subheading CALLING SEQUENCE: … … 479 598 @subheading DESCRIPTION: 480 599 481 @subheading NOTES: 482 483 @page 484 @subsection sigtimedwait 600 This function selects a pending signal based on the set specified in 601 @code{set}, atomically clears it from the set of pending signals, and 602 returns information about that signal in @code{info}. 603 604 @subheading NOTES: 605 606 NONE 607 608 @page 609 @subsection sigtimedwait - Synchronously Accept a Signal with Timeout 485 610 486 611 @subheading CALLING SEQUENCE: … … 511 636 @subheading DESCRIPTION: 512 637 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 638 This function selects a pending signal based on the set specified in 639 @code{set}, atomically clears it from the set of pending signals, and 640 returns information about that signal in @code{info}. The calling thread 641 will block up to @code{timeout} waiting for the signal to arrive. 642 643 @subheading NOTES: 644 645 If @code{timeout} is NULL, then the calling thread will wait forever for 646 the specified signal set. 647 648 @page 649 @subsection sigqueue - Queue a Signal to a Process 520 650 521 651 @subheading CALLING SEQUENCE: … … 554 684 555 685 @subheading DESCRIPTION: 556 557 @subheading NOTES: 558 559 560 @page 561 @subsection alarm 686 687 This function sends the signal specified by @code{signo} to the 688 process @code{pid} 689 690 @subheading NOTES: 691 692 NONE 693 694 @page 695 @subsection alarm - Schedule Alarm 562 696 563 697 @subheading CALLING SEQUENCE: … … 573 707 @subheading STATUS CODES: 574 708 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 709 This call always succeeds. 710 711 @subheading DESCRIPTION: 712 713 If there was a previous @code{alarm()} request with time remaining, 714 then this routine returns the number of seconds until that outstanding 715 alarm would have fired. If no previous @code{alarm()} request was 716 outstanding, then zero is returned. 717 718 @subheading NOTES: 719 720 NONE
Note: See TracChangeset
for help on using the changeset viewer.