\hypertarget{TASK_8ih}{
\section{TASK.ih File Reference}
\label{TASK_8ih}\index{TASK.ih@{TASK.ih}}
}
Task/Thread facility, a portable interface between Vx\-Works and POSIX implementations, inline version.  


{\tt \#include \char`\"{}PBI/Inline.h\char`\"{}}\par
{\tt \#include \char`\"{}PBI/Attribute.h\char`\"{}}\par
{\tt \#include \char`\"{}PBS/TASK.h\char`\"{}}\par
{\tt \#include \char`\"{}PBS/TBD.ih\char`\"{}}\par
{\tt \#include \char`\"{}PBI/TBD\_\-id.h\char`\"{}}\par


Include dependency graph for TASK.ih:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=197pt]{TASK_8ih__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
TASK\_\-\_\-EXP\_\-PROTO int \hyperlink{TASK_8ih_a0}{TASK\_\-\_\-priority\_\-number\_\-boost} (int priority, int boost) ATTR\_\-UNUSED\_\-OK
\begin{CompactList}\small\item\em Boosts the {\em priority\/} number by the {\em boost\/}. \item\end{CompactList}\item 
TASK\_\-\_\-EXP\_\-PROTO int \hyperlink{TASK_8ih_a1}{TASK\_\-\_\-priority\_\-number\_\-limit} (int priority) ATTR\_\-UNUSED\_\-OK
\begin{CompactList}\small\item\em Limits the priority number to fit within the specified bounds. \item\end{CompactList}\item 
TASK\_\-\_\-EXP\_\-PROTO \hyperlink{struct__TASK__tcb}{TASK\_\-tcb} $\ast$ \hyperlink{TASK_8ih_a2}{TASK\_\-\_\-self} (void) ATTR\_\-UNUSED\_\-OK
\begin{CompactList}\small\item\em Returns the tcb of the calling task. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Task/Thread facility, a portable interface between Vx\-Works and POSIX implementations, inline version. 

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


\footnotesize\begin{verbatim}

   CVS $Id: TASK.ih,v 1.4 2004/05/12 16:19:03 russell Exp $
\end{verbatim}\normalsize


\subsection{Function Documentation}
\hypertarget{TASK_8ih_a0}{
\index{TASK.ih@{TASK.ih}!TASK__priority_number_boost@{TASK\_\-\_\-priority\_\-number\_\-boost}}
\index{TASK__priority_number_boost@{TASK\_\-\_\-priority\_\-number\_\-boost}!TASK.ih@{TASK.ih}}
\subsubsection[TASK\_\-\_\-priority\_\-number\_\-boost]{\setlength{\rightskip}{0pt plus 5cm}TASK\_\-\_\-EXP\_\-FNC int TASK\_\-\_\-priority\_\-number\_\-boost (int {\em priority}, int {\em boost})}}
\label{TASK_8ih_a0}


Boosts the {\em priority\/} number by the {\em boost\/}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em priority}]The priority number to boost \item[{\em boost}]The amount to boost the {\em priority\/} number\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The boosted priority. This will be a number between the minimum, {\em TASK\_\-K\_\-PRIORITY\_\-MIN\/}, and maximum, {\em TASK\_\-K\_\-PRIORITY\_\-MAX\/} allowed priority numbers.\end{Desc}
The specified {\em priority\/} number is boosted by {\em boost\/}. A task assigned a higher priority will run before a task with a lower priority. On some platforms were the highest priority tasks run with a lower priority number, the actual priority number will, in fact, decrease.

The boost can be specified as a positive or negative number. Positive boosts will always result in a priority number that raises a task's absolute priority. Negative numbers will always result in a priority number that lowers a task's priority number.

In all cases the routine will limit the resulting priority between the minimum, {\em TASK\_\-K\_\-PRIORITY\_\-MIN\/} and {\em TASK\_\-K\_\-PRIORITY\_\-MAX\/} numbers. 

Here is the call graph for this function:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=215pt]{TASK_8ih_a0_cgraph}
\end{center}
\end{figure}
\hypertarget{TASK_8ih_a1}{
\index{TASK.ih@{TASK.ih}!TASK__priority_number_limit@{TASK\_\-\_\-priority\_\-number\_\-limit}}
\index{TASK__priority_number_limit@{TASK\_\-\_\-priority\_\-number\_\-limit}!TASK.ih@{TASK.ih}}
\subsubsection[TASK\_\-\_\-priority\_\-number\_\-limit]{\setlength{\rightskip}{0pt plus 5cm}TASK\_\-\_\-EXP\_\-FNC int TASK\_\-\_\-priority\_\-number\_\-limit (int {\em priority})}}
\label{TASK_8ih_a1}


Limits the priority number to fit within the specified bounds. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em priority}]The priority number to limit. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The limit priority number \end{Desc}
\hypertarget{TASK_8ih_a2}{
\index{TASK.ih@{TASK.ih}!TASK__self@{TASK\_\-\_\-self}}
\index{TASK__self@{TASK\_\-\_\-self}!TASK.ih@{TASK.ih}}
\subsubsection[TASK\_\-\_\-self]{\setlength{\rightskip}{0pt plus 5cm}TASK\_\-\_\-EXP\_\-FNC \hyperlink{struct__TASK__tcb}{TASK\_\-tcb} $\ast$ TASK\_\-\_\-self (void)}}
\label{TASK_8ih_a2}


Returns the tcb of the calling task. 

\begin{Desc}
\item[Returns:]The tcb of the calling task \end{Desc}


Here is the call graph for this function:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=119pt]{TASK_8ih_a2_cgraph}
\end{center}
\end{figure}
