1*08eb1913SGarrett D'Amore.\" Copyright 2014 Garrett D'Amore <garrett@damore.org> 2c10c16deSRichard Lowe.\" Copyright (c) 1980 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved Portions Copyright (c) 1992, 3c10c16deSRichard Lowe.\" X/Open Company Limited All Rights Reserved 4c10c16deSRichard Lowe.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at 5c10c16deSRichard Lowe.\" http://www.opengroup.org/bookstore/. 6c10c16deSRichard Lowe.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. 7c10c16deSRichard Lowe.\" This notice shall appear on any product containing this material. 8*08eb1913SGarrett D'Amore.Dd "Aug 16, 2014" 9*08eb1913SGarrett D'Amore.Dt UALARM 3C 10*08eb1913SGarrett D'Amore.Os 11*08eb1913SGarrett D'Amore.Sh NAME 12*08eb1913SGarrett D'Amore.Nm ualarm 13*08eb1913SGarrett D'Amore.Nd schedule signal after interval in microseconds 14*08eb1913SGarrett D'Amore.Sh SYNOPSIS 15*08eb1913SGarrett D'Amore.In unistd.h 16*08eb1913SGarrett D'Amore.Ft useconds_t 17*08eb1913SGarrett D'Amore.Fn ualarm "useconds_t useconds" "useconds_t interval" 18*08eb1913SGarrett D'Amore.Sh DESCRIPTION 19*08eb1913SGarrett D'AmoreThe 20*08eb1913SGarrett D'Amore.Fn ualarm 21*08eb1913SGarrett D'Amorefunction causes the 22*08eb1913SGarrett D'Amore.Dv SIGALRM 23*08eb1913SGarrett D'Amoresignal to be generated for 24c10c16deSRichard Lowethe calling process after the number of real-time microseconds specified by the 25*08eb1913SGarrett D'Amore.Fa useconds 26*08eb1913SGarrett D'Amoreargument has elapsed. When the 27*08eb1913SGarrett D'Amore.Fa interval 28*08eb1913SGarrett D'Amoreargument is 29c10c16deSRichard Lowenon-zero, repeated timeout notification occurs with a period in microseconds 30c10c16deSRichard Lowespecified by the \fIinterval\fR argument. If the notification signal, 31*08eb1913SGarrett D'Amore.Dv SIGALRM , 32*08eb1913SGarrett D'Amoreis not caught or ignored, the calling process is terminated. 33*08eb1913SGarrett D'Amore.Lp 34c10c16deSRichard LoweBecause of scheduling delays, resumption of execution when the signal is caught 35c10c16deSRichard Lowemay be delayed an arbitrary amount of time. 36*08eb1913SGarrett D'Amore.Lp 37*08eb1913SGarrett D'AmoreInteractions between 38*08eb1913SGarrett D'Amore.Fn ualarm 39*08eb1913SGarrett D'Amoreand either 40*08eb1913SGarrett D'Amore.Xr alarm 2 41*08eb1913SGarrett D'Amoreor 42*08eb1913SGarrett D'Amore.Xr sleep 3C 43*08eb1913SGarrett D'Amoreare unspecified. 44*08eb1913SGarrett D'Amore.Sh RETURN VALUES 45*08eb1913SGarrett D'AmoreThe 46*08eb1913SGarrett D'Amore.Fn ualarm 47*08eb1913SGarrett D'Amorefunction returns the number of microseconds remaining from 48*08eb1913SGarrett D'Amorethe previous 49*08eb1913SGarrett D'Amore.Fn ualarm 50*08eb1913SGarrett D'Amorecall. If no timeouts are pending or if 51*08eb1913SGarrett D'Amore.Fn ualarm 52*08eb1913SGarrett D'Amorehas not previously been called, 53*08eb1913SGarrett D'Amore.Fn ualarm 54*08eb1913SGarrett D'Amorereturns 0. 55*08eb1913SGarrett D'Amore.Sh ERRORS 56c10c16deSRichard LoweNo errors are defined. 57*08eb1913SGarrett D'Amore.Sh USAGE 58*08eb1913SGarrett D'AmoreThe 59*08eb1913SGarrett D'Amore.Fn ualarm 60*08eb1913SGarrett D'Amorefunction is a simplified interface to 61*08eb1913SGarrett D'Amore.Xr setitimer 2 , 62*08eb1913SGarrett D'Amoreand uses the 63*08eb1913SGarrett D'Amore.Dv ITIMER_REAL 64*08eb1913SGarrett D'Amoreinterval timer. It's use has been deprecated in favor of the 65*08eb1913SGarrett D'Amore.Xr timer_create 3C 66*08eb1913SGarrett D'Amorefamily of functions. 67*08eb1913SGarrett D'Amore.Sh INTERFACE STABILITY 68*08eb1913SGarrett D'Amore.Sy Obsolete Standard . 69*08eb1913SGarrett D'Amore.Sh SEE ALSO 70*08eb1913SGarrett D'Amore.Xr alarm 2 , 71*08eb1913SGarrett D'Amore.Xr setitimer 2 , 72*08eb1913SGarrett D'Amore.Xr sighold 3C , 73*08eb1913SGarrett D'Amore.Xr signal 3C , 74*08eb1913SGarrett D'Amore.Xr sleep 3C , 75*08eb1913SGarrett D'Amore.Xr timer_create 3C , 76*08eb1913SGarrett D'Amore.Xr usleep 3C , 77*08eb1913SGarrett D'Amore.Xr unistd.h 3HEAD , 78*08eb1913SGarrett D'Amore.Xr standards 5 79*08eb1913SGarrett D'Amore.Sh STANDARDS 80*08eb1913SGarrett D'AmoreThe 81*08eb1913SGarrett D'Amore.Fn ualarm 82*08eb1913SGarrett D'Amorefunction is available in the following compilation environments. See 83*08eb1913SGarrett D'Amore.Xr standards 5 . 84*08eb1913SGarrett D'Amore.Lp 85*08eb1913SGarrett D'Amore.Bl -bullet -compact 86*08eb1913SGarrett D'Amore.\".It 87*08eb1913SGarrett D'Amore.\".St -p1003.1-90 88*08eb1913SGarrett D'Amore.\".It 89*08eb1913SGarrett D'Amore.\".St -p1003.1b-93 90*08eb1913SGarrett D'Amore.\".It 91*08eb1913SGarrett D'Amore.\".St -p1003.1c-95 92*08eb1913SGarrett D'Amore.\".It 93*08eb1913SGarrett D'Amore.\".St -p1003.1-2001 94*08eb1913SGarrett D'Amore.\".It 95*08eb1913SGarrett D'Amore.\".St -xpg3 96*08eb1913SGarrett D'Amore.\".It 97*08eb1913SGarrett D'Amore.\".St -xpg4 98*08eb1913SGarrett D'Amore.It 99*08eb1913SGarrett D'Amore.St -xpg4.2 100*08eb1913SGarrett D'Amore.It 101*08eb1913SGarrett D'Amore.St -susv2 102*08eb1913SGarrett D'Amore.It 103*08eb1913SGarrett D'Amore.St -susv3 104*08eb1913SGarrett D'Amore.El 105*08eb1913SGarrett D'Amore.Lp 106*08eb1913SGarrett D'AmoreIt is marked obsolete in 107*08eb1913SGarrett D'Amore.St -susv3 , and was removed from 108*08eb1913SGarrett D'Amore.St -p1003.1-2008 . 109