\hypertarget{TOC_8ih}{
\section{TOC.ih File Reference}
\label{TOC_8ih}\index{TOC.ih@{TOC.ih}}
}
Time\-Out Control, inline routines. 

{\tt \#include \char`\"{}PBI/Inline.h\char`\"{}}\par
{\tt \#include \char`\"{}PBI/Attribute.h\char`\"{}}\par
{\tt \#include \char`\"{}IPBS/TOC.h\char`\"{}}\par


Include dependency graph for TOC.ih:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=309pt]{TOC_8ih__incl}
\end{center}
\end{figure}


This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=220pt]{TOC_8ih__dep__incl}
\end{center}
\end{figure}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\hypertarget{TOC_8ih_a0}{
\#define \hyperlink{TOC_8ih_a0}{TOC\_\-\_\-EXP\_\-PROTO}~INLINE\_\-USR\_\-EXP\_\-PROTO}
\label{TOC_8ih_a0}

\begin{CompactList}\small\item\em Export Prototype spec. \item\end{CompactList}\item 
\hypertarget{TOC_8ih_a1}{
\#define \hyperlink{TOC_8ih_a1}{TOC\_\-\_\-LCL\_\-PROTO}~INLINE\_\-USR\_\-LCL\_\-PROTO}
\label{TOC_8ih_a1}

\begin{CompactList}\small\item\em Internal Prototype spec. \item\end{CompactList}\item 
\hypertarget{TOC_8ih_a2}{
\#define \hyperlink{TOC_8ih_a2}{TOC\_\-\_\-EXP\_\-FNC}~INLINE\_\-USR\_\-EXP\_\-FNC}
\label{TOC_8ih_a2}

\begin{CompactList}\small\item\em Export Function declaration. \item\end{CompactList}\item 
\hypertarget{TOC_8ih_a3}{
\#define \hyperlink{TOC_8ih_a3}{TOC\_\-\_\-LCL\_\-FNC}~INLINE\_\-USR\_\-LCL\_\-FNC}
\label{TOC_8ih_a3}

\begin{CompactList}\small\item\em Internal Function declaration. \item\end{CompactList}\item 
\hypertarget{TOC_8ih_a4}{
\#define \hyperlink{TOC_8ih_a4}{\_\-OK}~ATTR\_\-UNUSED\_\-OK}
\label{TOC_8ih_a4}

\begin{CompactList}\small\item\em Abbrev for ATTR\_\-UNUSED\_\-OK, undef'd in this file. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
TOC\_\-\_\-EXP\_\-PROTO void \hyperlink{TOC_8ih_a5}{TOC\_\-\_\-set\_\-s} (\hyperlink{struct__TOC}{TOC} $\ast$toc, \hyperlink{TOV_8h_a1}{TOV\_\-cvt\_\-s} fnc, \hyperlink{TOC__comdefs_8h_a8}{TOS} tmo) \_\-OK
\begin{CompactList}\small\item\em Sets the TOV converter and value for small range timeouts. \item\end{CompactList}\item 
TOC\_\-\_\-EXP\_\-PROTO void \hyperlink{TOC_8ih_a6}{TOC\_\-\_\-set\_\-v} (\hyperlink{struct__TOC}{TOC} $\ast$toc, \hyperlink{TOV_8h_8vx-xxx-xxx_a8}{TOV} tmo) \_\-OK
\begin{CompactList}\small\item\em Sets the TOV converter and value for an immediate TOV. \item\end{CompactList}\item 
TOC\_\-\_\-EXP\_\-PROTO void \hyperlink{TOC_8ih_a7}{TOC\_\-\_\-set\_\-x} (\hyperlink{struct__TOC}{TOC} $\ast$toc, \hyperlink{TOV_8h_a2}{TOV\_\-cvt\_\-x} fnc, \hyperlink{TOC__comdefs_8h_a9}{TOX} tmo) \_\-OK
\begin{CompactList}\small\item\em Sets the TOV converter and value for extended range timeouts. \item\end{CompactList}\item 
TOC\_\-\_\-EXP\_\-PROTO void \hyperlink{TOC_8ih_a8}{TOC\_\-\_\-reset\_\-tos} (\hyperlink{struct__TOC}{TOC} $\ast$tos, \hyperlink{TOC__comdefs_8h_a8}{TOS} tmo) \_\-OK
\begin{CompactList}\small\item\em Resets the small range timeout value. The timeout conversion routine is assumed to be have previously set using TOC\_\-set\_\-s. \item\end{CompactList}\item 
TOC\_\-\_\-EXP\_\-PROTO void \hyperlink{TOC_8ih_a9}{TOC\_\-\_\-reset\_\-tov} (\hyperlink{struct__TOC}{TOC} $\ast$toc, \hyperlink{TOV_8h_8vx-xxx-xxx_a8}{TOV} tmo) \_\-OK
\begin{CompactList}\small\item\em Resets the immediate timeout value. The timeout conversion routine is assumed to be have previously set using TOC\_\-set\_\-v. \item\end{CompactList}\item 
TOC\_\-\_\-EXP\_\-PROTO void \hyperlink{TOC_8ih_a10}{TOC\_\-\_\-reset\_\-tox} (\hyperlink{struct__TOC}{TOC} $\ast$toc, \hyperlink{TOC__comdefs_8h_a9}{TOX} tmo) \_\-OK
\begin{CompactList}\small\item\em Resets the extended range timeout value. The timeout conversion routine is assumed to be have previously set using TOC\_\-set\_\-x. \item\end{CompactList}\item 
TOC\_\-\_\-EXP\_\-PROTO \hyperlink{TOV_8h_8vx-xxx-xxx_a8}{TOV} \hyperlink{TOC_8ih_a11}{TOC\_\-\_\-compute} (const \hyperlink{struct__TOC}{TOC} $\ast$toc) \_\-OK
\begin{CompactList}\small\item\em Computes the timeout value (TOV) specified by the timeout control structure. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Time\-Out Control, inline routines. 

\begin{Desc}
\item[Author:]JJRussell - \href{mailto:russell@slac.stanford.edu}{\tt russell@slac.stanford.edu}\end{Desc}


\footnotesize\begin{verbatim}    CVS $Id: TOC.ih,v 1.1.1.1 2006/02/10 21:45:37 saxton Exp $
\end{verbatim}
\normalsize


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 Time\-Out Value, TOV.

\subsection{Function Documentation}
\hypertarget{TOC_8ih_a11}{
\index{TOC.ih@{TOC.ih}!TOC__compute@{TOC\_\-\_\-compute}}
\index{TOC__compute@{TOC\_\-\_\-compute}!TOC.ih@{TOC.ih}}
\subsubsection[TOC\_\-\_\-compute]{\setlength{\rightskip}{0pt plus 5cm}TOC\_\-\_\-EXP\_\-FNC \hyperlink{TOV_8h_8vx-xxx-xxx_a8}{TOV} TOC\_\-\_\-compute (const \hyperlink{struct__TOC}{TOC} $\ast$ {\em toc})}}
\label{TOC_8ih_a11}


Computes the timeout value (TOV) specified by the timeout control structure. 

\begin{Desc}
\item[Returns:]The timeout value specified by the timeout control structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em toc}]The timeout control structure\end{description}
\end{Desc}
\hypertarget{TOC_8ih_a8}{
\index{TOC.ih@{TOC.ih}!TOC__reset_tos@{TOC\_\-\_\-reset\_\-tos}}
\index{TOC__reset_tos@{TOC\_\-\_\-reset\_\-tos}!TOC.ih@{TOC.ih}}
\subsubsection[TOC\_\-\_\-reset\_\-tos]{\setlength{\rightskip}{0pt plus 5cm}TOC\_\-\_\-EXP\_\-FNC void TOC\_\-\_\-reset\_\-tos (\hyperlink{struct__TOC}{TOC} $\ast$ {\em toc}, \hyperlink{TOC__comdefs_8h_a8}{TOS} {\em tmo})}}
\label{TOC_8ih_a8}


Resets the small range timeout value. The timeout conversion routine is assumed to be have previously set using TOC\_\-set\_\-s. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em toc}]The target TOC structure \item[{\em tmo}]The new small range timeout value to convert.\end{description}
\end{Desc}
\begin{Desc}
\item[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.\end{Desc}
\hypertarget{TOC_8ih_a9}{
\index{TOC.ih@{TOC.ih}!TOC__reset_tov@{TOC\_\-\_\-reset\_\-tov}}
\index{TOC__reset_tov@{TOC\_\-\_\-reset\_\-tov}!TOC.ih@{TOC.ih}}
\subsubsection[TOC\_\-\_\-reset\_\-tov]{\setlength{\rightskip}{0pt plus 5cm}TOC\_\-\_\-EXP\_\-FNC void TOC\_\-\_\-reset\_\-tov (\hyperlink{struct__TOC}{TOC} $\ast$ {\em toc}, \hyperlink{TOV_8h_8vx-xxx-xxx_a8}{TOV} {\em tmo})}}
\label{TOC_8ih_a9}


Resets the immediate timeout value. The timeout conversion routine is assumed to be have previously set using TOC\_\-set\_\-v. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em toc}]The target TOC structure \item[{\em tmo}]The new extended range timeout value to convert.\end{description}
\end{Desc}
\begin{Desc}
\item[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.\end{Desc}
\hypertarget{TOC_8ih_a10}{
\index{TOC.ih@{TOC.ih}!TOC__reset_tox@{TOC\_\-\_\-reset\_\-tox}}
\index{TOC__reset_tox@{TOC\_\-\_\-reset\_\-tox}!TOC.ih@{TOC.ih}}
\subsubsection[TOC\_\-\_\-reset\_\-tox]{\setlength{\rightskip}{0pt plus 5cm}TOC\_\-\_\-EXP\_\-FNC void TOC\_\-\_\-reset\_\-tox (\hyperlink{struct__TOC}{TOC} $\ast$ {\em toc}, \hyperlink{TOC__comdefs_8h_a9}{TOX} {\em tmo})}}
\label{TOC_8ih_a10}


Resets the extended range timeout value. The timeout conversion routine is assumed to be have previously set using TOC\_\-set\_\-x. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em toc}]The target TOC structure \item[{\em tmo}]The new extended range timeout value to convert.\end{description}
\end{Desc}
\begin{Desc}
\item[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.\end{Desc}
\hypertarget{TOC_8ih_a5}{
\index{TOC.ih@{TOC.ih}!TOC__set_s@{TOC\_\-\_\-set\_\-s}}
\index{TOC__set_s@{TOC\_\-\_\-set\_\-s}!TOC.ih@{TOC.ih}}
\subsubsection[TOC\_\-\_\-set\_\-s]{\setlength{\rightskip}{0pt plus 5cm}TOC\_\-\_\-EXP\_\-FNC void TOC\_\-\_\-set\_\-s (\hyperlink{struct__TOC}{TOC} $\ast$ {\em toc}, \hyperlink{TOV_8h_a1}{TOV\_\-cvt\_\-s} {\em fnc}, \hyperlink{TOC__comdefs_8h_a8}{TOS} {\em tmo})}}
\label{TOC_8ih_a5}


Sets the TOV converter and value for small range timeouts. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em toc}]The target TOC structure \item[{\em fnc}]The extended range to TOV converter function. \item[{\em tmo}]The value to convert\end{description}
\end{Desc}
\hypertarget{TOC_8ih_a6}{
\index{TOC.ih@{TOC.ih}!TOC__set_v@{TOC\_\-\_\-set\_\-v}}
\index{TOC__set_v@{TOC\_\-\_\-set\_\-v}!TOC.ih@{TOC.ih}}
\subsubsection[TOC\_\-\_\-set\_\-v]{\setlength{\rightskip}{0pt plus 5cm}TOC\_\-\_\-EXP\_\-FNC void TOC\_\-\_\-set\_\-v (\hyperlink{struct__TOC}{TOC} $\ast$ {\em toc}, \hyperlink{TOV_8h_8vx-xxx-xxx_a8}{TOV} {\em tmo})}}
\label{TOC_8ih_a6}


Sets the TOV converter and value for an immediate TOV. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em toc}]The target TOC structure \item[{\em tmo}]The timeout value to set.\end{description}
\end{Desc}
\hypertarget{TOC_8ih_a7}{
\index{TOC.ih@{TOC.ih}!TOC__set_x@{TOC\_\-\_\-set\_\-x}}
\index{TOC__set_x@{TOC\_\-\_\-set\_\-x}!TOC.ih@{TOC.ih}}
\subsubsection[TOC\_\-\_\-set\_\-x]{\setlength{\rightskip}{0pt plus 5cm}TOC\_\-\_\-EXP\_\-FNC void TOC\_\-\_\-set\_\-x (\hyperlink{struct__TOC}{TOC} $\ast$ {\em toc}, \hyperlink{TOV_8h_a2}{TOV\_\-cvt\_\-x} {\em fnc}, \hyperlink{TOC__comdefs_8h_a9}{TOX} {\em tmo})}}
\label{TOC_8ih_a7}


Sets the TOV converter and value for extended range timeouts. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em toc}]The target TOC structure \item[{\em fnc}]The extended range to TOV converter. \item[{\em tmo}]The extended range timeout value to convert\end{description}
\end{Desc}