TOC_comdefs.h File Reference

TimeOut Control,data structures and typedefs common to TOC.h and TOC.ih. More...

Defines
#define	TOS_K_NOWAIT   ((TOS)(0))
	Specifies a NOWAIT TOC (short timeout value).
#define	TOS_K_FOREVER   ((TOS)(-1))
	Specifies a WAIT FOREVER TOS (short timeout value).
#define	TOX_K_NOWAIT   ((TOX)(0))
	Specifies a NOWAIT TOC (extended timeout value).
#define	TOX_K_FOREVER   ((TOX)(-1))
	Specifies a WAIT FOREVER TOS (extended timeout value).
#define	TOC_FOREVER   ( (const TOC *)(-1) )
	Can be used to specify a WAIT FOREVER TOC. Note that this acts as readonly structure, so it cannot be altered by passing it to one of the TOC_set routine.
#define	TOC_NOWAIT   ( (const TOC *)( 0) )
	Can be used to specify a NOWAIT TOC. Note that this acts as readonly structure, so it cannot be altered by passing it to one of the TOC_set routine.
#define	TOC_IS_FOREVER(_toc)   ( (_toc) == TOC_FOREVER )
	Tests if the specified a _toc, is TOC_FOREVER.
#define	TOC_IS_NOWAIT(_toc)   ( (_toc) == TOC_NOWAIT )
	Tests if the specified a _toc, is TOC_NOWAIT.
Typedefs
typedef unsigned int	TOS
	Typedef for a short timeout value. Short timeout values are guaranteed to cover timeouts up to 4 seconds.
typedef long long int	TOX
	Typedef for an extend range timeout value. Extended range timeout values are guaranteed to cover at least 275 years.
typedef struct _TOC	TOC
	typedef for struct _TOC

---

Detailed Description

TimeOut Control,data structures and typedefs common to TOC.h and TOC.ih.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: TOC_comdefs.h,v 1.2 2004/12/07 16:13:06 russell Exp $

A minimal definition of TOC when only a reference to TOC is needed along with the special TOC_NOWAIT and TOC_FOREVER definitions.

---

Define Documentation

#define TOC_IS_FOREVER

(

_toc

)

( (_toc) == TOC_FOREVER )

Tests if the specified a _toc, is TOC_FOREVER.

Parameters:

_toc

The TOC to test

Referenced by FORK_create(), and RW__tmr_init().

#define TOC_IS_NOWAIT

(

_toc

)

( (_toc) == TOC_NOWAIT )

Tests if the specified a _toc, is TOC_NOWAIT.

Parameters:

_toc

The TOC to test

Referenced by FORK_create(), LI__removeW_toc(), PL__getW_toc(), PL__removeW_toc(), QI__removeW_toc(), rng_allocate(), and RW__tmr_init().