\section{ost::Thread\-Lock Class Reference}
\label{classost_1_1_thread_lock}\index{ost::ThreadLock@{ost::ThreadLock}}
The {\bf Thread\-Lock}{\rm (p.\,\pageref{classost_1_1_thread_lock})} class impliments a thread rwlock for optimal reader performance on systems which have rwlock support, and reverts to a simple mutex for those that do not.Posix rwlock extension for protected access.  


{\tt \#include $<$thread.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Thread\-Lock} ()
\begin{CompactList}\small\item\em Create a process shared thread lock object. \item\end{CompactList}\item 
virtual {\bf $\sim$Thread\-Lock} ()
\begin{CompactList}\small\item\em Destroy a process shared thread lock object. \item\end{CompactList}\item 
void {\bf read\-Lock} (void)
\begin{CompactList}\small\item\em Aquire a read lock for the current object. \item\end{CompactList}\item 
void {\bf write\-Lock} (void)
\begin{CompactList}\small\item\em Aquire a write lock for the current object. \item\end{CompactList}\item 
bool {\bf try\-Read\-Lock} (void)
\begin{CompactList}\small\item\em Attempt read lock for current object. \item\end{CompactList}\item 
bool {\bf try\-Write\-Lock} (void)
\begin{CompactList}\small\item\em Attempt write lock for current object. \item\end{CompactList}\item 
void {\bf unlock} (void)
\begin{CompactList}\small\item\em Release any held locks. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
The {\bf Thread\-Lock}{\rm (p.\,\pageref{classost_1_1_thread_lock})} class impliments a thread rwlock for optimal reader performance on systems which have rwlock support, and reverts to a simple mutex for those that do not.Posix rwlock extension for protected access. 

\begin{Desc}
\item[Author:]David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{ost::ThreadLock@{ost::Thread\-Lock}!ThreadLock@{ThreadLock}}
\index{ThreadLock@{ThreadLock}!ost::ThreadLock@{ost::Thread\-Lock}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Thread\-Lock::Thread\-Lock ()}\label{classost_1_1_thread_lock_3844f7c41e77b7f498bcb64e2880ae60}


Create a process shared thread lock object. 

\index{ost::ThreadLock@{ost::Thread\-Lock}!~ThreadLock@{$\sim$ThreadLock}}
\index{~ThreadLock@{$\sim$ThreadLock}!ost::ThreadLock@{ost::Thread\-Lock}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::Thread\-Lock::$\sim$Thread\-Lock ()\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_thread_lock_73d294adbe345f5727f84f75ed03d4b4}


Destroy a process shared thread lock object. 



\subsection{Member Function Documentation}
\index{ost::ThreadLock@{ost::Thread\-Lock}!readLock@{readLock}}
\index{readLock@{readLock}!ost::ThreadLock@{ost::Thread\-Lock}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Thread\-Lock::read\-Lock (void)}\label{classost_1_1_thread_lock_0c60b2cbd8c51b9d5e097422f667ad2a}


Aquire a read lock for the current object. 

\index{ost::ThreadLock@{ost::Thread\-Lock}!tryReadLock@{tryReadLock}}
\index{tryReadLock@{tryReadLock}!ost::ThreadLock@{ost::Thread\-Lock}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::Thread\-Lock::try\-Read\-Lock (void)}\label{classost_1_1_thread_lock_0b6a57ab08b3ee3ef688aaa3f8164869}


Attempt read lock for current object. 

\begin{Desc}
\item[Returns:]true on success. \end{Desc}
\index{ost::ThreadLock@{ost::Thread\-Lock}!tryWriteLock@{tryWriteLock}}
\index{tryWriteLock@{tryWriteLock}!ost::ThreadLock@{ost::Thread\-Lock}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::Thread\-Lock::try\-Write\-Lock (void)}\label{classost_1_1_thread_lock_b405f01d33cc07e7f362a1860d0cdce9}


Attempt write lock for current object. 

\begin{Desc}
\item[Returns:]true on success. \end{Desc}
\index{ost::ThreadLock@{ost::Thread\-Lock}!unlock@{unlock}}
\index{unlock@{unlock}!ost::ThreadLock@{ost::Thread\-Lock}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Thread\-Lock::unlock (void)}\label{classost_1_1_thread_lock_6aaee369f359cb509baa3accb82db979}


Release any held locks. 

\index{ost::ThreadLock@{ost::Thread\-Lock}!writeLock@{writeLock}}
\index{writeLock@{writeLock}!ost::ThreadLock@{ost::Thread\-Lock}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Thread\-Lock::write\-Lock (void)}\label{classost_1_1_thread_lock_436668b798e53addfe451d641a7faeec}


Aquire a write lock for the current object. 



The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf thread.h}\end{CompactItemize}