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


{\tt \#include $<$PBI/Inline.h$>$}\par
{\tt \#include $<$PBI/Attribute.h$>$}\par
{\tt \#include $<$PBS/TASK.h$>$}\par
{\tt \#include $<$PBS/TBD.ih$>$}\par
{\tt \#include $<$PBI/TBD\_\-id.h$>$}\par
\subsection*{Functions}
\begin{CompactItemize}
\item 
TASK\_\-\_\-EXP\_\-PROTO int \hyperlink{TASK_8ih_a2b15d5cea507c716c3c0aae860e46c3}{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_9dafb536eb3461f4edc6488570d37cc3}{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_73dd1afbc444c24ad86070811f7434ba}{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 VxWorks 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.5 2011/03/24 23:05:44 apw Exp $
\end{verbatim}
\normalsize
 

\subsection{Function Documentation}
\hypertarget{TASK_8ih_a2b15d5cea507c716c3c0aae860e46c3}{
\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_a2b15d5cea507c716c3c0aae860e46c3}


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. 

References TASK\_\-\_\-priority\_\-number\_\-limit().

Referenced by TASK\_\-priority\_\-number\_\-compute().\hypertarget{TASK_8ih_9dafb536eb3461f4edc6488570d37cc3}{
\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_9dafb536eb3461f4edc6488570d37cc3}


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}


References TASK\_\-K\_\-PRIORITY\_\-LIMITS\_\-MAX, and TASK\_\-K\_\-PRIORITY\_\-LIMITS\_\-MIN.

Referenced by TASK\_\-\_\-priority\_\-number\_\-boost(), TASK\_\-attr\_\-priority\_\-set(), and TASK\_\-priority\_\-number\_\-compute().\hypertarget{TASK_8ih_73dd1afbc444c24ad86070811f7434ba}{
\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 {\bf TASK\_\-tcb} $\ast$ TASK\_\-\_\-self (void)}}
\label{TASK_8ih_73dd1afbc444c24ad86070811f7434ba}


Returns the tcb of the calling task. 

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


References TBD\_\-\_\-get(), and TBD\_\-\_\-locate().

Referenced by TASK\_\-resume(), TASK\_\-suspend(), and TASK\_\-wait().