TOV.c.px-xxx-xxx File Reference

Timeout service routines implementation for a POSIX compliant platform. More...

#include <PBS/TSS.h>
#include <impl/TOV_pvtdefs.h.px-xxx-xxx>

Defines
#define	NSECS_IN_A_SECOND   (1000 * 1000 * 1000)
	Convenience symbol for a billion.
Functions
TOV	TOV_add_nsecs (TOV tov, unsigned int dnsecs)
	Returns the timeout value delta nanoseconds from the specified tov.
TOV	TOV_add_nsecx (TOV tov, signed long long int dnsecx)
	Returns the timeout value delta nanoseconds from the specified tov.
TOV	TOV_from_nsecx (long long int dnsecx)
	Returns the timeout value dsecx nanoseconds from the current time.
TOV	TOV_from_nsecs (unsigned int dnsecs)
	Returns the timeout value dnsecs nanoseconds from the current time.
TOV	TOV_from_usecs (unsigned int dusecs)
	Returns the timeout value delta microseconds from the current time.
TOV	TOV_from_secs (unsigned int dsecs)
	Returns the timeout value dsecs seconds from the current time.
TOV	TOV_from_wct (WCT_time wct)
	Returns the timeout value corresponding to the specified Wall Clock Time wct.

---

Detailed Description

Timeout service routines implementation for a POSIX compliant platform.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: TOV.c.px-xxx-xxx,v 1.6 2011/03/24 23:05:47 apw Exp $

---

Function Documentation

TOV TOV_add_nsecs	(	TOV	tov,
		unsigned int	dnsecs
	)

Returns the timeout value delta nanoseconds from the specified tov.

Parameters:

	tov	The TOV to add to
	dnsecs	The number of nanoseconds to add.

Return values:

The

timeout value delta nanoseconds from tov.

References NSECS_IN_A_SECOND, _TOV_u::tov, and _TOV_u::ts.

TOV TOV_add_nsecx	(	TOV	tov,
		signed long long int	dnsecx
	)

Returns the timeout value delta nanoseconds from the specified tov.

Parameters:

	tov	The TOV to add to
	dnsecx	The number of nanoseconds to add.

Return values:

The

timeout value delta nanoseconds from tov.

References NSECS_IN_A_SECOND, _TOV_u::tov, and _TOV_u::ts.

Referenced by WUT_keepalive_rtn().

TOV TOV_from_nsecs

(

unsigned int

dnsecs

)

Returns the timeout value dnsecs nanoseconds from the current time.

Parameters:

dnsecs

The delta time in nanoseconds

Return values:

The

timeout value dnsecs nanoseconds from the current time.

References _TOV_u::tov, _TOV_u::ts, and TSS_nsecsTOtodAdd().

Referenced by TASK_pause(), WUT_sys_connect(), and wut_sys_shutdown().

TOV TOV_from_nsecx

(

long long int

dnsecx

)

Returns the timeout value dsecx nanoseconds from the current time.

Parameters:

dnsecx

The delta time in extended nanoseconds.

Return values:

The

timeout value delta nanoseconds from the current time.

References _TOV_u::tov, _TOV_u::ts, and TSS_nsecxTOtodAdd().

TOV TOV_from_secs

(

unsigned int

dsecs

)

Returns the timeout value dsecs seconds from the current time.

Parameters:

dsecs

The delta time in seconds.

Return values:

The

timeout value dsecs seconds from the current time.

References _TOV_u::tov, _TOV_u::ts, and TSS_secsTOtodAdd().

TOV TOV_from_usecs

(

unsigned int

dusecs

)

Returns the timeout value delta microseconds from the current time.

Parameters:

dusecs

The delta time in microseconds.

Return values:

The

timeout value usecs microseconds from the current time.

References _TOV_u::tov, _TOV_u::ts, and TSS_usecsTOtodAdd().

TOV TOV_from_wct

(

WCT_time

wct

)

Returns the timeout value corresponding to the specified Wall Clock Time wct.

Parameters:

wct

The Wall Clock Time to convert to a TOV.

Return values:

The

corresponding TOV

References _TOV_u::tov, _TOV_u::ts, TSS_from_wct(), and WCT_K_UTB_OFFSET_IN_SECS.