\hypertarget{MTX_8h}{
\section{MTX.h File Reference}
\label{MTX_8h}\index{MTX.h@{MTX.h}}
}
Simple mutex, interface definition.  




This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=105pt]{MTX_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hyperlink{MTX_8h_8px-xxx-xxx_a0}{MTX} \hyperlink{MTX_8h_a0}{MTX\_\-create} (unsigned int options)
\begin{CompactList}\small\item\em Creates a mutex. \item\end{CompactList}\item 
unsigned int \hyperlink{MTX_8h_a1}{MTX\_\-lock} (\hyperlink{MTX_8h_8px-xxx-xxx_a0}{MTX} mutex)
\begin{CompactList}\small\item\em Locks the mutex. This call may block until the mutex can be locked. \item\end{CompactList}\item 
unsigned int \hyperlink{MTX_8h_a2}{MTX\_\-unlock} (\hyperlink{MTX_8h_8px-xxx-xxx_a0}{MTX} mutex)
\begin{CompactList}\small\item\em Unlocks the mutex. \item\end{CompactList}\item 
unsigned int \hyperlink{MTX_8h_a3}{MTX\_\-destroy} (\hyperlink{MTX_8h_8px-xxx-xxx_a0}{MTX} mutex)
\begin{CompactList}\small\item\em Destroys the mutex. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Simple mutex, interface definition. 

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


\footnotesize\begin{verbatim}

    CVS $Id: MTX.h,v 1.2 2004/12/07 16:13:04 russell Exp $
\end{verbatim}\normalsize


\subsection{Function Documentation}
\hypertarget{MTX_8h_a0}{
\index{MTX.h@{MTX.h}!MTX_create@{MTX\_\-create}}
\index{MTX_create@{MTX\_\-create}!MTX.h@{MTX.h}}
\subsubsection[MTX\_\-create]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{MTX_8h_8px-xxx-xxx_a0}{MTX} MTX\_\-create (unsigned int {\em options})}}
\label{MTX_8h_a0}


Creates a mutex. 

\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em NON-NULL}]A pointer to the created mutex \item[{\em NULL}]Error in the creation\end{description}
\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em options}]A bit mask of options formed from the enumeration MTX\_\-OPTIONS\_\-M \end{description}
\end{Desc}
\hypertarget{MTX_8h_a3}{
\index{MTX.h@{MTX.h}!MTX_destroy@{MTX\_\-destroy}}
\index{MTX_destroy@{MTX\_\-destroy}!MTX.h@{MTX.h}}
\subsubsection[MTX\_\-destroy]{\setlength{\rightskip}{0pt plus 5cm}unsigned int MTX\_\-destroy (\hyperlink{MTX_8h_8px-xxx-xxx_a0}{MTX} {\em mutex})}}
\label{MTX_8h_a3}


Destroys the mutex. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mutex}]The mutex to destroy \end{description}
\end{Desc}
\hypertarget{MTX_8h_a1}{
\index{MTX.h@{MTX.h}!MTX_lock@{MTX\_\-lock}}
\index{MTX_lock@{MTX\_\-lock}!MTX.h@{MTX.h}}
\subsubsection[MTX\_\-lock]{\setlength{\rightskip}{0pt plus 5cm}unsigned int MTX\_\-lock (\hyperlink{MTX_8h_8px-xxx-xxx_a0}{MTX} {\em mutex})}}
\label{MTX_8h_a1}


Locks the mutex. This call may block until the mutex can be locked. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mutex}]The mutex to lock \end{description}
\end{Desc}
\hypertarget{MTX_8h_a2}{
\index{MTX.h@{MTX.h}!MTX_unlock@{MTX\_\-unlock}}
\index{MTX_unlock@{MTX\_\-unlock}!MTX.h@{MTX.h}}
\subsubsection[MTX\_\-unlock]{\setlength{\rightskip}{0pt plus 5cm}unsigned int MTX\_\-unlock (\hyperlink{MTX_8h_8px-xxx-xxx_a0}{MTX} {\em mutex})}}
\label{MTX_8h_a2}


Unlocks the mutex. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mutex}]The mutex to lock \end{description}
\end{Desc}
