Manpage of UNTIMEOUT

Description: Manual Page

Keywords: ss7 ss7/ip ss7 over ip ss7 mtp ss7 sccp ss7 tcap sigtran mtp sccp tcap openss7 acb56 linux telephony pstn linux telephony linux nebs linux compactpci

---

UNTIMEOUT

Section: Linux Fast-STREAMS DDI/DKI (9)
Updated: 2008-10-31
Index Return to Main Contents

---

NAME

untimeout - stop a timer

SYNOPSIS

#include <sys/stream.h>
#include <sys/dki.h>

int untimeout(int toid);

toid_t untimeout(toid_t toid);

timeout_id_t untimeout(timeout_id_t toid);

ARGUMENTS

toid

the timeout identifier returned by timeout(9) or qtimeout(9).

INTERFACE

STREAMS.

DESCRIPTION

untimeout() stops a timer previously started with timeout(9). toid is the timer identifier that was returned from a previous call to timeout(9).

untimeout() is typically used to stop timers before they expire, and to deallocate timers before a stream is closed.

RETURN

untimeout() returns a timo_t defined as follows:

typedef unsigned long toid_t;
typedef unsigned long timeout_id_t;

The return value from untimeout() is undefined and ignored.

ERRORS

untimeout() fails silently (retval is ignored) when the timer associated with the timer identifier toid no longer exists or is invalid.

CONTEXT

untimeout() can be called from any context including: user context, qi_qopen(9), qi_qclose(9), qi_putp(9) or qi_srvp(9), procedures, bufcall(9), qbufcall(9), timeout(9), or qtimeout(9) callback functions, or interrupt service routines.

MP-STREAMS

untimeout() is MP-safe; however, the caller of untimeout() must ensure that the callback function has not returned running before calling untimeout().

NOTICES

untimeout() can be called with a toid returned by timeout(9), or qtimeout(9).

untimeout() must be called for all outstanding timeout calls from the qi_qclose(9) procedure of the modules before exiting and unloading.

Because Linux Fast-STREAMS[1] uses an out-dating pointer for the returned toid_t, untimeout() must be called promptly for outstanding buffer calls.

SEE ALSO

timeout(9), dtimeout(9), itimeout(9), qtimeout(9).

BUGS

untimeout() has no known bugs.

COMPATIBILITY

untimeout() is compatible with SVR 4.2 MP DDI/DKI[2], and systems based on SVR 4[3] with the following portability considerations:

---

The UnixWare® function prototype returns void.

---

Under LiS[4], timeout(9) creates a Linux timer structure, assigns it a sequential integer timer identifier, and places it in a timer list. Whenever LiS stops a timer, it checks the list for the integer timer identifier with interrupts disabled. This is an exhaustive linear search. This is inefficient. STREAMS drivers or modules that stop timers often will experience poorer performance than if the Linux kernel timer facility was used directly.

---

AIX®[5] describes this function as accepting an int bcid and returning an int return value. Linux Fast-STREAMS use of an int for toid_t and timeout_id_t maintains compatibility with SVR 3[6] based systems maintaining the int prototype.

---

Solaris®[7] describes this function as having the following prototype:

clock_t untimeout(timeout_id_t toid);

The clock_t return value is described as being -1 when the toid is not found and zero or positive otherwise.

---

Both AIX®[5] and OSF/1®[8] have different prototypes for timeout(9) and untimeout(9) when used for STREAMS as when used for other drivers. The prototypes for timeout(9) and untimeout(9) for use by STREAMS are the old SVR 3[6] definitions which use an int for the toid_t.

---

Binary compatibility is not guaranteed.

See STREAMS(9) for additional compatibility information.

CONFORMANCE

SVR 4.2 MP DDI/DKI[2].

HISTORY

untimeout() first appeared in SVR 2[9].

REFERENCES

[1]

streams-0.9.2, Linux Fast-STREAMS (LfS) 0.9.2 Source Code, Brian Bidulock, ed., OpenSS7 Corporation. <http://www.openss7.org/>

[2]

USL DDI/DKI, Device Driver Interface/Driver-Kernel Interface (DDI/DKI) Reference Manual for Intel Processors, 1992, (Englewood Cliffs, New Jersey), AT&T UNIX System Laboratories, Inc., Prentice Hall.

[3]

SVR 4 DDI/DKI, UNIX® System V Release 4 Device Driver Interface/Driver-Kernel Interface (DDI/DKI) Reference Manual, 1990, (Englewood Cliffs, New Jersey), AT&T UNIX System Laboratories, Inc., Prentice Hall.

[4]

LIS 2.18, Linux STREAMS (LiS) 2.18.6 Source Code, Brian Bidulock, ed., OpenSS7 Corporation. <http://www.openss7.org/>

[5]

AIX® 5L Version 5.1, AIX 5L Version 5.1 Documentation, 2001, (Boulder, Colorado), Internatonal Business Machines Corp., IBM. <http://publibn.boulder.ibm.com/>

[6]

SVR 3, UNIX® System V Release 3 STREAMS Programmer's Guide, (Englewood Cliffs, New Jersey), AT&T UNIX System Laboratories, Inc., Prentice Hall.

[7]

Solaris® 8, Solaris 8 Docmentation, 2001, (Santa Clara, California), Sun Microsystems, Inc., Sun. <http://docs.sun.com/>

[8]

Digital® UNIX (OSF/1.2), Digital UNIX Documentation Library, 2003, (Palo Alto, California), Digital Equipment Corporation, Hewlett-Packard Company. <http://www.true64unix.compaq.com/docs/>

[9]

SVR 2, UNIX® System V Release 2 Programmer's Manual, (Englewood Cliffs, New Jersey), AT&T UNIX System Laboratories, Inc., Prentice Hall.

TRADEMARKS

OpenSS7tm

is a trademark of OpenSS7 Corporation.

Linux®

is a registered trademark of Linus Torvalds.

UNIX®

is a registered trademark of The Open Group.

Solaris®

is a registered trademark of Sun Microsystems.

Other trademarks are the property of their respective owners.

IDENTIFICATION

Linux Fast-STREAMS: Package streams version 0.9.2.4 released 2008-10-31.

Copyright©1997-2008OpenSS7 Corp. All Rights Reserved.
(See roff source for permission notice.)

---

Index

NAME

SYNOPSIS

ARGUMENTS

INTERFACE

DESCRIPTION

RETURN

ERRORS

CONTEXT

MP-STREAMS

NOTICES

SEE ALSO

BUGS

COMPATIBILITY

CONFORMANCE

HISTORY

REFERENCES

TRADEMARKS

IDENTIFICATION

---

This document was created by man2html, using the manual pages.
Time: 17:28:19 GMT, May 20, 2013