GETITIMER(2) BSD System Calls Manual GETITIMER(2)

NAME
     ggeettiittiimmeerr, sseettiittiimmeerr - get/set value of interval timer

SYNOPSIS
     ##iinncclluuddee <>

     ##ddeeffiinnee IITTIIMMEERRRREEAALL      00
     ##ddeeffiinnee IITTIIMMEERRVVIIRRTTUUAALL   11
     ##ddeeffiinnee IITTIIMMEERRPPRROOFF      22

     int
     ggeettiittiimmeerr(int which, struct itimerval *value);

     int
     sseettiittiimmeerr(int which, const struct itimerval *restrict value,
         struct itimerval *restrict ovalue);

DESCRIPTION
     The system provides each process with three interval timers, defined in
     .  The ggeettiittiimmeerr() call returns the current value for the
     timer specified in which in the structure at value.  The sseettiittiimmeerr() call
     sets a timer to the specified value (returning the previous value of the
     timer if ovalue is non-nil).

     A timer value is defined by the itimerval structure:

           struct itimerval {
                   struct  timeval itinterval;    /* timer interval */
                   struct  timeval itvalue;       /* current value */
           };

     If itvalue is non-zero, it indicates the time to the next timer expira-
     tion.  If itinterval is non-zero, it specifies a value to be used in
     reloading itvalue when the timer expires.  Setting itvalue to 0 dis-
     ables a timer.  Setting itinterval to 0 causes a timer to be disabled
     after its next expiration (assuming itvalue is non-zero).

     Time values smaller than the resolution of the system clock are rounded
     up to this resolution (typically 10 milliseconds).

     The ITIMERREAL timer decrements in real time.  A SIGALRM signal is
     delivered when this timer expires.

     The ITIMERVIRTUAL timer decrements in process virtual time.  It runs
     only when the process is executing.  A SIGVTALRM signal is delivered when
     it expires.

     The ITIMERPROF timer decrements both in process virtual time and when
     the system is running on behalf of the process.  It is designed to be
     used by interpreters in statistically profiling the execution of inter-
     preted programs.  Each time the ITIMERPROF timer expires, the SIGPROF
     signal is delivered.  Because this signal may interrupt in-progress sys-
     tem calls, programs using this timer must be prepared to restart inter-
     rupted system calls.

NNOOTTEESS
     Three macros for manipulating time values are defined in .
     Timerclear sets a time value to zero, timerisset tests if a time value is
     non-zero, and timercmp compares two time values (beware that >= and <= do
     not work with this macro).

RETURN VALUES
     Upon successful completion, a value of 0 is returned.  Otherwise, a value
     of -1 is returned and the global integer variable errno is set to indi-
     cate the error.

EERRRROORRSS
     GGeettiittiimmeerr() and sseettiittiimmeerr() will fail if:

     [EFAULT]           The value parameter specified a bad address.

     [EINVAL]           The value parameter specified a time that was too
                        large to be handled or not in the canonical form.

     [EINVAL]           The which parameter was invalid.

SEE ALSO
     gettimeofday(2), select(2), sigaction(2)

HISTORY     The ggeettiittiimmeerr() function call appeared in 4.2BSD.

4.2 Berkeley Distribution      December 11, 1993     4.2 Berkeley Distribution