RCS file: /usr1/CVS/rtems/doc/posix_users/signal.t,v
retrieving revision 1.6
diff -u -r1.6 signal.t
|
|
|
35 | 35 | @item @code{sigtimedwait} - Synchronously Accept a Signal with Timeout |
36 | 36 | @item @code{sigqueue} - Queue a Signal to a Process |
37 | 37 | @item @code{alarm} - Schedule Alarm |
| 38 | @item @code{ualarm} - Schedule Alarm in Microseconds |
38 | 39 | @end itemize |
39 | 40 | |
40 | 41 | @section Background |
… |
… |
|
860 | 861 | @subheading CALLING SEQUENCE: |
861 | 862 | |
862 | 863 | @example |
863 | | #include <signal.h> |
| 864 | #include <unistd.h> |
864 | 865 | |
865 | 866 | unsigned int alarm( |
866 | 867 | unsigned int seconds |
… |
… |
|
871 | 872 | |
872 | 873 | This call always succeeds. |
873 | 874 | |
| 875 | If there was a previous @code{alarm()} request with time remaining, |
| 876 | then this routine returns the number of seconds until that outstanding |
| 877 | alarm would have fired. If no previous @code{alarm()} request was |
| 878 | outstanding, then zero is returned. |
| 879 | |
874 | 880 | @subheading DESCRIPTION: |
875 | 881 | |
876 | | If there was a previous @code{alarm()} request with time remaining, |
| 882 | The @code{alarm()} service causes the @code{SIGALRM} signal to |
| 883 | be generated after the number of seconds specified by |
| 884 | @code{seconds} has elapsed. |
| 885 | |
| 886 | @subheading NOTES: |
| 887 | |
| 888 | Alarm requests do not queue. If @code{alarm} is called while |
| 889 | a previous request is outstanding, the call will result in |
| 890 | rescheduling the time at which the @code{SIGALRM} signal |
| 891 | will be generated. |
| 892 | |
| 893 | If the notification signal, @code{SIGALRM}, is not caught or ignored, the |
| 894 | calling process is terminated. |
| 895 | |
| 896 | @c |
| 897 | @c |
| 898 | @c |
| 899 | @page |
| 900 | @subsection ualarm - Schedule Alarm in Microseconds |
| 901 | |
| 902 | @findex alarm |
| 903 | @findex microseonds alarm |
| 904 | @findex usecs alarm |
| 905 | @cindex schedule alarm in microseonds |
| 906 | |
| 907 | @subheading CALLING SEQUENCE: |
| 908 | |
| 909 | @example |
| 910 | #include <unistd.h> |
| 911 | |
| 912 | useconds_t ualarm( |
| 913 | useconds_t useconds, |
| 914 | useconds_t interval |
| 915 | ); |
| 916 | @end example |
| 917 | |
| 918 | @subheading STATUS CODES: |
| 919 | |
| 920 | This call always succeeds. |
| 921 | |
| 922 | If there was a previous @code{ualarm()} request with time remaining, |
877 | 923 | then this routine returns the number of seconds until that outstanding |
878 | 924 | alarm would have fired. If no previous @code{alarm()} request was |
879 | 925 | outstanding, then zero is returned. |
880 | 926 | |
| 927 | @subheading DESCRIPTION: |
| 928 | |
| 929 | The @code{ualarm()} service causes the @code{SIGALRM} signal to |
| 930 | be generated after the number of microseconds specified by |
| 931 | @code{useconds} has elapsed. |
| 932 | |
| 933 | When @code{interval} is non-zero, repeated timeout notification occurs |
| 934 | with a period in microseconds specified by @code{interval}. |
| 935 | |
881 | 936 | @subheading NOTES: |
882 | 937 | |
883 | | NONE |
| 938 | Alarm requests do not queue. If @code{alarm} is called while |
| 939 | a previous request is outstanding, the call will result in |
| 940 | rescheduling the time at which the @code{SIGALRM} signal |
| 941 | will be generated. |
| 942 | |
| 943 | If the notification signal, @code{SIGALRM}, is not caught or ignored, the |
| 944 | calling process is terminated. |
| 945 | |