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


\subsection*{Functions}
\begin{CompactItemize}
\item 
\hyperlink{MTX_8h_8vx-xxx-xxx_8ff55bbc376fe4c5d025850d7b4fc28a}{MTX} \hyperlink{MTX_8h_eec90a7cf85c0b54b9428319df1f8fe3}{MTX\_\-create} (unsigned int options)
\begin{CompactList}\small\item\em Creates a mutex. \item\end{CompactList}\item 
unsigned int \hyperlink{MTX_8h_f5c078b68fab358b709c63e96bc24bd6}{MTX\_\-lock} (\hyperlink{MTX_8h_8vx-xxx-xxx_8ff55bbc376fe4c5d025850d7b4fc28a}{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_c33ab43dbe949622f5b73ff492c42a83}{MTX\_\-unlock} (\hyperlink{MTX_8h_8vx-xxx-xxx_8ff55bbc376fe4c5d025850d7b4fc28a}{MTX} mutex)
\begin{CompactList}\small\item\em Unlocks the mutex. \item\end{CompactList}\item 
unsigned int \hyperlink{MTX_8h_3d9e65b411f0fd3bb18a966baee675d6}{MTX\_\-destroy} (\hyperlink{MTX_8h_8vx-xxx-xxx_8ff55bbc376fe4c5d025850d7b4fc28a}{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 2011/03/25 21:15:01 saxton Exp $
\end{verbatim}
\normalsize
 

\subsection{Function Documentation}
\hypertarget{MTX_8h_eec90a7cf85c0b54b9428319df1f8fe3}{
\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}{\bf MTX} MTX\_\-create (unsigned int {\em options})}}
\label{MTX_8h_eec90a7cf85c0b54b9428319df1f8fe3}


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_3d9e65b411f0fd3bb18a966baee675d6}{
\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 ({\bf MTX} {\em mutex})}}
\label{MTX_8h_3d9e65b411f0fd3bb18a966baee675d6}


Destroys the mutex. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mutex}]The mutex to destroy \end{description}
\end{Desc}
\hypertarget{MTX_8h_f5c078b68fab358b709c63e96bc24bd6}{
\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 ({\bf MTX} {\em mutex})}}
\label{MTX_8h_f5c078b68fab358b709c63e96bc24bd6}


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_c33ab43dbe949622f5b73ff492c42a83}{
\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 ({\bf MTX} {\em mutex})}}
\label{MTX_8h_c33ab43dbe949622f5b73ff492c42a83}


Unlocks the mutex. 

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