SVR5

untimeout(D3)

untimeout -- cancel previous timeout request

Synopsis

   #include <sys/types.h>
   #include <sys/ddi.h>
   
   void untimeout(toid_t id);

Description

untimeout cancels the pending timeout request specified by id.

Arguments

id: Non-zero identifier returned from a prior call to timeout(D3) (singlethreaded drivers) or from a prior call to dtimeout(D3) or itimeout(D3) (multithreaded drivers).

Return values

None

Usage

On uniprocessor systems, if untimeout is called while any function called by the pending timeout request is running, then there is no effect.

On multiprocessor systems, if untimeout is called while any function called by the pending timeout request is running, untimeout will not return until the function completes.

Note that any function that runs as a result of a call to timeout (or to dtimeout or itimeout) cannot use untimeout to cancel itself.

A repeating timer, such as that started by using the TO_PERIODIC flag in the ticks argument of itimeout(D3) or dtimeout can be canceled by untimeout(D3), just like any other timeout.

Context and synchronization

Non-blockable, interrupt, user, or blockable context.

For itimeout(D3) and dtimeout(D3), the untimeout can only be performed from interrupt levels less than, or equal to, the level specified when the function was scheduled.

Examples

See unbufcall(D3str) for an example of untimeout.

Hardware applicability

All

Version applicability

ddi: 1, 2, 3, 4, 5, 5mp, 6, 6mp, 7, 7mp, 7.1, 7.1mp, 8, 8mp

Differences between versions

The id argument is currently defined as a toid_t data type. In earlier releases, it was an int.

References

delay(D3), dtimeout(D3), itimeout(D3), timeout(D3), unbufcall(D3str)

``Timeouts'' in HDK Technical Reference