man-pages/man3/ualarm.3.html
2021-03-31 01:06:50 +01:00

250 lines
5.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of UALARM</TITLE>
</HEAD><BODY>
<H1>UALARM</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
ualarm - schedule signal after given number of microseconds
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/unistd.h">unistd.h</A>&gt;</B>
<B>useconds_t ualarm(useconds_t </B><I>usecs</I><B>, useconds_t </B><I>interval</I><B>);</B>
</PRE>
<P>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>ualarm</B>():
<DL COMPACT><DT id="1"><DD>
<DL COMPACT>
<DT id="2">Since glibc 2.12:<DD>
<PRE>
(_XOPEN_SOURCE&nbsp;&gt;=&nbsp;500) &amp;&amp; ! (_POSIX_C_SOURCE&nbsp;&gt;=&nbsp;200809L)
|| /* Glibc since 2.19: */ _DEFAULT_SOURCE
|| /* Glibc versions &lt;= 2.19: */ _BSD_SOURCE
<DT id="3"></PRE>
<DD>
Before glibc 2.12:
_BSD_SOURCE || _XOPEN_SOURCE&nbsp;&gt;=&nbsp;500
</DL>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>ualarm</B>()
function causes the signal
<B>SIGALRM</B>
to be sent to the invoking process after (not less than)
<I>usecs</I>
microseconds.
The delay may be lengthened slightly by any system activity
or by the time spent processing the call or by the
granularity of system timers.
<P>
Unless caught or ignored, the
<B>SIGALRM</B>
signal will terminate the process.
<P>
If the
<I>interval</I>
argument is nonzero, further
<B>SIGALRM</B>
signals will be sent every
<I>interval</I>
microseconds after the first.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
This function returns the number of microseconds remaining for
any alarm that was previously set, or 0 if no alarm was pending.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="4"><B>EINTR</B>
<DD>
Interrupted by a signal; see
<B><A HREF="/cgi-bin/man/man2html?7+signal">signal</A></B>(7).
<DT id="5"><B>EINVAL</B>
<DD>
<I>usecs</I> or <I>interval</I> is not smaller than 1000000.
(On systems where that is considered an error.)
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>ualarm</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
4.3BSD, POSIX.1-2001.
POSIX.1-2001 marks
<B>ualarm</B>()
as obsolete.
POSIX.1-2008 removes the specification of
<B>ualarm</B>().
4.3BSD, SUSv2, and POSIX do not define any errors.
<A NAME="lbAI">&nbsp;</A>
<H2>NOTES</H2>
POSIX.1-2001 does not specify what happens if the
<I>usecs</I>
argument is 0.
On Linux (and probably most other systems),
the effect is to cancel any pending alarm.
<P>
The type
<I>useconds_t</I>
is an unsigned integer type capable of holding integers
in the range [0,1000000].
On the original BSD implementation, and in glibc before version 2.1,
the arguments to
<B>ualarm</B>()
were instead typed as
<I>unsigned int</I>.
Programs will be more portable if they never mention
<I>useconds_t</I>
explicitly.
<P>
The interaction of this function with
other timer functions such as
<B><A HREF="/cgi-bin/man/man2html?2+alarm">alarm</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?3+sleep">sleep</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?2+nanosleep">nanosleep</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+setitimer">setitimer</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+timer_create">timer_create</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+timer_delete">timer_delete</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+timer_getoverrun">timer_getoverrun</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+timer_gettime">timer_gettime</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+timer_settime">timer_settime</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?3+usleep">usleep</A></B>(3)
is unspecified.
<P>
This function is obsolete.
Use
<B><A HREF="/cgi-bin/man/man2html?2+setitimer">setitimer</A></B>(2)
or POSIX interval timers
(<B><A HREF="/cgi-bin/man/man2html?2+timer_create">timer_create</A></B>(2),
etc.)
instead.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?2+alarm">alarm</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+getitimer">getitimer</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+nanosleep">nanosleep</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+select">select</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+setitimer">setitimer</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?3+usleep">usleep</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?7+time">time</A></B>(7)
<A NAME="lbAK">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="6"><A HREF="#lbAB">NAME</A><DD>
<DT id="7"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="8"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="9"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="10"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="11"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="12"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="13"><A HREF="#lbAI">NOTES</A><DD>
<DT id="14"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="15"><A HREF="#lbAK">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:59 GMT, March 31, 2021
</BODY>
</HTML>