GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> PBS / dev > pbs / rhel6-32
#include <PBS/TOV.h>
#include <PBS/TOC_comdefs.h>
Classes | |
struct | _TOC_cvt_s |
Structure specifying the conversion of an small range timeout (TOS) to a timeout value (TOV), via user provided TOV_cvt_s function. More... | |
struct | _TOC_cvt_v |
Structure specifying the timeout is being provided as an immediate timeout value (TOV). More... | |
struct | _TOC_cvt_x |
Structure specifying the conversion of an unsigned int to a timeout value (TOV), via user provided TOV_cvt_x style function. More... | |
union | _TOC_cvt |
A union of the all the converter styles. More... | |
struct | _TOC |
The timeout conversion control structure. More... | |
Typedefs | |
typedef enum _TOC_style | TOC_style |
typedef struct _TOC_cvt_s | TOC_cvt_s |
Typedef for struct _TOC_cvt_s. | |
typedef struct _TOC_cvt_v | TOC_cvt_v |
Typedef for struct _TOC_cvt_v. | |
typedef struct _TOC_cvt_x | TOC_cvt_x |
Typedef for struct _TOC_cvt_x. | |
typedef union _TOC_cvt | TOC_cvt |
Typedef for union _TOC_cvt. | |
Enumerations | |
enum | _TOC_style { TOC_K_STYLE_S = -1, TOC_K_STYLE_V = 0, TOC_K_STYLE_X = 1 } |
Enumerates the different way that a timeout may be specified. More... | |
Functions | |
void | TOC_set_s (TOC *toc, TOV_cvt_s fnc, TOS tmo) |
Sets the TOV converter and value for small range timeouts. | |
void | TOC_set_v (TOC *toc, TOV tmo) |
Sets the TOV converter and value for an immediate TOV. | |
void | TOC_set_x (TOC *toc, TOV_cvt_x fnc, TOX tmo) |
Sets the TOV converter and value for extended range timeouts. | |
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. | |
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. | |
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. | |
TOV | TOC_compute (const TOC *toc) |
Computes the timeout value (TOV) specified by the timeout control structure. |
CVS $Id: TOC.h,v 1.5 2011/03/24 23:05:44 apw Exp $
Typedef for struct _TOC_cvt_s.
This is one of the conversion styles, specified by TOC_styles, e.g. TOC_K_STYLE_CVT_S.
Typedef for struct _TOC_cvt_v.
This is one of the conversion styles, specified by TOC_styles, e.g. TOC_K_STYLE_CVT_V.
Typedef for struct _TOC_cvt_x.
This is one of the conversion styles, specified by TOC_styles, e.g. TOC_K_STYLE_CVT_X.
brief Typedef for enum _TOC_style
enum _TOC_style |
Computes the timeout value (TOV) specified by the timeout control structure.
toc | The timeout control structure |
Referenced by RW__tmr_wait().
Resets the small range timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_s.
toc | The target Timeout control structure. | |
tmo | The new small range timeout value to convert. |
Resets the immediate timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_v.
toc | The target Timeout control structure. | |
tmo | The new extended range timeout value to convert. |
Resets the extended range timeout value. The timeout conversion routine is assumed to be have previously set using TOC_set_x.
toc | The target Timeout control structure | |
tmo | The new extended range timeout value to convert. |
Sets the TOV converter and value for small range timeouts.
toc | The target Timeout control structure | |
fnc | The extended range to TOV converter function. | |
tos | The value to convert |
Sets the TOV converter and value for an immediate TOV.
toc | The target Timeout control structure | |
tmo | The TOV value to set. |
Sets the TOV converter and value for extended range timeouts.
toc | The target Timeout control structure. | |
fnc | The extended range to TOV converter. | |
tmo | The extended range timeout value to convert. |