Mac Developer Library Developer
Search

 

This manual page is part of Xcode Tools version 5.0

To obtain these tools:

If you are running a version of Xcode Tools other than 5.0, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.




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

NAME
     getitimer, setitimer -- get/set value of interval timer

SYNOPSIS
     #include <sys/time.h>

     #define ITIMER_REAL      0
     #define ITIMER_VIRTUAL   1
     #define ITIMER_PROF      2

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

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

DESCRIPTION
     The system provides each process with three interval timers, defined in <sys/time.h>.  The getitimer()
     call returns the current value for the timer specified in which in the structure at value.  The
     setitimer() 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 it_interval;    /* timer interval */
                   struct  timeval it_value;       /* current value */
           };

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

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

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

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

     The ITIMER_PROF 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
     interpreted programs.  Each time the ITIMER_PROF timer expires, the SIGPROF signal is delivered.
     Because this signal may interrupt in-progress system calls, programs using this timer must be prepared
     to restart interrupted system calls.

NOTES
     Three macros for manipulating time values are defined in <sys/time.h>.  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 indicate the error.

ERRORS
     Getitimer() and setitimer() 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 getitimer() function call appeared in 4.2BSD.

4.2 Berkeley Distribution      December 11, 1993     4.2 Berkeley Distribution

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Feedback