timer_getexpstatus()

Get the expiry status of a timer

Synopsis:

#include <time.h>

int timer_getexpstatus( timer_t timerid );

Arguments:

timerid
A timer_t object that holds a timer ID, as set by timer_create().

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The timer_getexpstatus() function gets the expiry status of the time with the ID given by timerid.


Note: This function is based on a POSIX draft. If you want your code to be more portable, then instead of calling timer_getexpstatus(), call timer_gettime() and check the amount of time left on the timer.

Returns:

0
The timer has expired.
-1
An error occurred (errno is set).

Errors:

EINVAL
The timer specified by timerid doesn't exist.

Classification:

QNX Neutrino

Safety:
Cancellation point No
Interrupt handler No
Signal handler Yes
Thread Yes

See also:

timer_create(), timer_delete(), timer_getoverrun(), timer_gettime(), timer_settime(), TimerInfo()

Clocks, Timers, and Getting a Kick Every So Often chapter of Getting Started with QNX Neutrino

Tick, Tock: Understanding the Neutrino Microkernel's Concept of Time chapter of the QNX Neutrino Programmer's Guide