---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > PBS / V2-10-6

Constituent: pbs     Tag: linux-gcc

---

         

---

TOC.ih File Reference

TimeOut Control, inline routines. More...

#include "PBI/Inline.h"
#include "PBI/Attribute.h"
#include "PBS/TOC.h"

Include dependency graph for TOC.ih:

This graph shows which files directly or indirectly include this file:

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.

---

Detailed Description

TimeOut Control, inline routines.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: TOC.ih,v 1.5 2005/10/01 01:00:12 russell 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.

---

Function Documentation

TOC__EXP_FNC TOV TOC__compute (  const TOC *  toc  )

Computes the timeout value (TOV) specified by the timeout control structure. Returns: The timeout value specified by the timeout control structure Parameters: toc  The timeout control structure

TOC__EXP_FNC void TOC__reset_tos (  TOC *  toc, TOS  tmo )

Resets the small range timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_s. Parameters: toc  The target TOC structure tmo  The new small range timeout value to convert. Warning: No check is made to assure that the conversion style is TOC_K_STYLE_S. It is the user's responsibility to ensure this.

TOC__EXP_FNC void TOC__reset_tov (  TOC *  toc, TOV  tmo )

Resets the immediate timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_v. Parameters: toc  The target TOC structure tmo  The new extended range timeout value to convert. Warning: No check is made to assure that the conversion style is TOC_K_STYLE_V. It is the user's responsibility to ensure this.

TOC__EXP_FNC void TOC__reset_tox (  TOC *  toc, TOX  tmo )

Resets the extended range timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_x. Parameters: toc  The target TOC structure tmo  The new extended range timeout value to convert. Warning: No check is made to assure that the conversion style is TOC_K_STYLE_X. It is the user's responsibility to ensure this.

TOC__EXP_FNC void TOC__set_s (  TOC *  toc, TOV_cvt_s  fnc, TOS  tmo )

Sets the TOV converter and value for small range timeouts. Parameters: toc  The target TOC structure fnc  The extended range to TOV converter function. tmo  The value to convert

TOC__EXP_FNC void TOC__set_v (  TOC *  toc, TOV  tmo )

Sets the TOV converter and value for an immediate TOV. Parameters: toc  The target TOC structure tmo  The timeout value to set.

TOC__EXP_FNC void TOC__set_x (  TOC *  toc, TOV_cvt_x  fnc, TOX  tmo )

Sets the TOV converter and value for extended range timeouts. Parameters: toc  The target TOC structure fnc  The extended range to TOV converter. tmo  The extended range timeout value to convert

---