GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> PBS / V2-12-1 > pbs / rhel4-32
#include <PBI/Inline.h>
#include <PBI/Attribute.h>
#include <PBS/TOC.h>
Defines | |
#define | TOC__EXP_PROTO INLINE_USR_EXP_PROTO |
Export Prototype spec. | |
#define | TOC__LCL_PROTO INLINE_USR_LCL_PROTO |
Internal Prototype spec. | |
#define | TOC__EXP_FNC INLINE_USR_EXP_FNC |
Export Function declaration. | |
#define | TOC__LCL_FNC INLINE_USR_LCL_FNC |
Internal Function declaration. | |
#define | _OK ATTR_UNUSED_OK |
Abbrev for ATTR_UNUSED_OK, undef'd in this file. | |
Functions | |
TOC__EXP_PROTO void | TOC__set_s (TOC *toc, TOV_cvt_s fnc, TOS tmo) _OK |
Sets the TOV converter and value for small range timeouts. | |
TOC__EXP_PROTO void | TOC__set_v (TOC *toc, TOV tmo) _OK |
Sets the TOV converter and value for an immediate TOV. | |
TOC__EXP_PROTO void | TOC__set_x (TOC *toc, TOV_cvt_x fnc, TOX tmo) _OK |
Sets the TOV converter and value for extended range timeouts. | |
TOC__EXP_PROTO void | TOC__reset_tos (TOC *tos, TOS tmo) _OK |
Resets the small range timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_s. | |
TOC__EXP_PROTO void | TOC__reset_tov (TOC *toc, TOV tmo) _OK |
Resets the immediate timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_v. | |
TOC__EXP_PROTO void | TOC__reset_tox (TOC *toc, TOX tmo) _OK |
Resets the extended range timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_x. | |
TOC__EXP_PROTO TOV | TOC__compute (const TOC *toc) _OK |
Computes the timeout value (TOV) specified by the timeout control structure. |
CVS $Id: TOC.ih,v 1.6 2011/03/24 23:05:44 apw Exp $
Provides a set of inline utility functions to define a timeout control structure. This structure is passed to most all routines that requirement implement a timeout. It serves as a universal method to convert a variety of time representations to a TimeOut Value, TOV.
Computes the timeout value (TOV) specified by the timeout control structure.
toc | The timeout control structure |
References _TOC::cvt, _TOC_cvt_x::fnc, _TOC_cvt_s::fnc, _TOC_cvt::s, _TOC::style, _TOC_cvt_v::tmo, _TOC_cvt_x::tmo, _TOC_cvt_s::tmo, _TOC_cvt::v, and _TOC_cvt::x.
Resets the small range timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_s.
toc | The target TOC structure | |
tmo | The new small range timeout value to convert. |
References _TOC::cvt, _TOC_cvt::s, and _TOC_cvt_s::tmo.
Resets the immediate timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_v.
toc | The target TOC structure | |
tmo | The new extended range timeout value to convert. |
References _TOC::cvt, _TOC_cvt_x::tmo, and _TOC_cvt::x.
Resets the extended range timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_x.
toc | The target TOC structure | |
tmo | The new extended range timeout value to convert. |
References _TOC::cvt, _TOC_cvt_x::tmo, and _TOC_cvt::x.
Sets the TOV converter and value for small range timeouts.
toc | The target TOC structure | |
fnc | The extended range to TOV converter function. | |
tmo | The value to convert |
References _TOC::cvt, _TOC_cvt_s::fnc, _TOC_cvt::s, _TOC::style, _TOC_cvt_s::tmo, and TOC_K_STYLE_S.
Sets the TOV converter and value for an immediate TOV.
toc | The target TOC structure | |
tmo | The timeout value to set. |
References _TOC::cvt, _TOC::style, _TOC_cvt_v::tmo, TOC_K_STYLE_V, and _TOC_cvt::v.
Sets the TOV converter and value for extended range timeouts.
toc | The target TOC structure | |
fnc | The extended range to TOV converter. | |
tmo | The extended range timeout value to convert |
References _TOC::cvt, _TOC_cvt_x::fnc, _TOC::style, _TOC_cvt_x::tmo, TOC_K_STYLE_X, and _TOC_cvt::x.