untimeout(D3) untimeout(D3)
NAME
untimeout - cancel previous timeout request
SYNOPSIS
#include <sys/types.h>
#include <sys/ddi.h>
void untimeout(toid_t 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).
DESCRIPTION
untimeout cancels the pending timeout request specified by id.
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.
Level
Base or Interrupt, with the following exception on
multiprocessor systems: 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.
Copyright 1994 Novell, Inc. Page 1
untimeout(D3) untimeout(D3)
Synchronization Constraints
Does not sleep.
Driver-defined basic locks, read/write locks, and sleep locks
may not be held across calls to this function if these locks
are contended by the function being canceled.
Examples
See unbufcall(D3) for an example of untimeout.
REFERENCES
delay(D3), dtimeout(D3), itimeout(D3), timeout(D3),
unbufcall(D3)
NOTICES
Portability
All processors
Applicability
ddi: 1, 2, 3, 4, 5, 5mp, 6, 6mp, 7, 7mp
The id argument is currently defined as a toid_t data type.
In earlier releases, it was an int.
Copyright 1994 Novell, Inc. Page 2