\section{ost::Fixed\-Buffer Class Reference}
\label{classost_1_1_fixed_buffer}\index{ost::FixedBuffer@{ost::FixedBuffer}}
A buffer class that holds a known capacity of fixed sized objects defined during creation.producer/consumer buffer for fixed size objects.  


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

Inheritance diagram for ost::Fixed\-Buffer::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3cm]{classost_1_1_fixed_buffer}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Fixed\-Buffer} (size\_\-t capacity, size\_\-t objsize)
\begin{CompactList}\small\item\em Create a buffer of known capacity for objects of a specified size. \item\end{CompactList}\item 
{\bf Fixed\-Buffer} (const {\bf Fixed\-Buffer} \&fb)
\begin{CompactList}\small\item\em Create a copy of an existing fixed size buffer and duplicate it's contents. \item\end{CompactList}\item 
virtual {\bf $\sim$Fixed\-Buffer} ()
\begin{CompactList}\small\item\em Destroy the fixed buffer and free the memory used to store objects. \item\end{CompactList}\item 
{\bf Fixed\-Buffer} \& {\bf operator=} (const {\bf Fixed\-Buffer} \&fb)
\item 
bool {\bf is\-Valid} (void)
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
size\_\-t {\bf on\-Peek} (void $\ast$buf)
\begin{CompactList}\small\item\em Return the first object in the buffer. \item\end{CompactList}\item 
size\_\-t {\bf on\-Wait} (void $\ast$buf)
\begin{CompactList}\small\item\em Wait for and return a fixed object in the buffer. \item\end{CompactList}\item 
size\_\-t {\bf on\-Post} (void $\ast$buf)
\begin{CompactList}\small\item\em Post an object of the appropriate size into the buffer. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
A buffer class that holds a known capacity of fixed sized objects defined during creation.producer/consumer buffer for fixed size objects. 

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




\subsection{Constructor \& Destructor Documentation}
\index{ost::FixedBuffer@{ost::Fixed\-Buffer}!FixedBuffer@{FixedBuffer}}
\index{FixedBuffer@{FixedBuffer}!ost::FixedBuffer@{ost::Fixed\-Buffer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Fixed\-Buffer::Fixed\-Buffer (size\_\-t {\em capacity}, size\_\-t {\em objsize})}\label{classost_1_1_fixed_buffer_154d01f4960fabb6d0310a33290e3e96}


Create a buffer of known capacity for objects of a specified size. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em capacity}]of the buffer. \item[{\em objsize}]for each object held in the buffer. \end{description}
\end{Desc}
\index{ost::FixedBuffer@{ost::Fixed\-Buffer}!FixedBuffer@{FixedBuffer}}
\index{FixedBuffer@{FixedBuffer}!ost::FixedBuffer@{ost::Fixed\-Buffer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Fixed\-Buffer::Fixed\-Buffer (const {\bf Fixed\-Buffer} \& {\em fb})}\label{classost_1_1_fixed_buffer_bee76b72fa800332666f57e6f62fc551}


Create a copy of an existing fixed size buffer and duplicate it's contents. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em fb}]existing {\bf Fixed\-Buffer}{\rm (p.\,\pageref{classost_1_1_fixed_buffer})} object. \end{description}
\end{Desc}
\index{ost::FixedBuffer@{ost::Fixed\-Buffer}!~FixedBuffer@{$\sim$FixedBuffer}}
\index{~FixedBuffer@{$\sim$FixedBuffer}!ost::FixedBuffer@{ost::Fixed\-Buffer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::Fixed\-Buffer::$\sim$Fixed\-Buffer ()\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_fixed_buffer_70f1e3b40a36ed683d9d2d08e5e8d14f}


Destroy the fixed buffer and free the memory used to store objects. 



\subsection{Member Function Documentation}
\index{ost::FixedBuffer@{ost::Fixed\-Buffer}!isValid@{isValid}}
\index{isValid@{isValid}!ost::FixedBuffer@{ost::Fixed\-Buffer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::Fixed\-Buffer::is\-Valid (void)\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_fixed_buffer_0a374a1a50ae78ce64db9e4ab25991d2}




Reimplemented from {\bf ost::Buffer} {\rm (p.\,\pageref{classost_1_1_buffer_255237cf9eebf6010546e884933ff8ba})}.\index{ost::FixedBuffer@{ost::Fixed\-Buffer}!onPeek@{onPeek}}
\index{onPeek@{onPeek}!ost::FixedBuffer@{ost::Fixed\-Buffer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::Fixed\-Buffer::on\-Peek (void $\ast$ {\em buf})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classost_1_1_fixed_buffer_e0a0b8dcb25e97313de5b998e1f22bfd}


Return the first object in the buffer. 

\begin{Desc}
\item[Returns:]predefined size of this buffers objects. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]pointer to copy contents of head of buffer to. \end{description}
\end{Desc}


Implements {\bf ost::Buffer} {\rm (p.\,\pageref{classost_1_1_buffer_5879caf00bd75cd972d84b822cb77ef0})}.\index{ost::FixedBuffer@{ost::Fixed\-Buffer}!onPost@{onPost}}
\index{onPost@{onPost}!ost::FixedBuffer@{ost::Fixed\-Buffer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::Fixed\-Buffer::on\-Post (void $\ast$ {\em buf})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classost_1_1_fixed_buffer_5d39b3282dd4a18d79456f7f16962b35}


Post an object of the appropriate size into the buffer. 

\begin{Desc}
\item[Returns:]predefined size of this buffers objects. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]pointer to data to copy into the buffer. \end{description}
\end{Desc}


Implements {\bf ost::Buffer} {\rm (p.\,\pageref{classost_1_1_buffer_7ee3158e74f0e50e91f14bf370feb1fa})}.\index{ost::FixedBuffer@{ost::Fixed\-Buffer}!onWait@{onWait}}
\index{onWait@{onWait}!ost::FixedBuffer@{ost::Fixed\-Buffer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::Fixed\-Buffer::on\-Wait (void $\ast$ {\em buf})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classost_1_1_fixed_buffer_8364661c1b2d2114d87be12479b04a47}


Wait for and return a fixed object in the buffer. 

\begin{Desc}
\item[Returns:]predefined size of this buffers objects. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]pointer to hold object returned from the buffer. \end{description}
\end{Desc}


Implements {\bf ost::Buffer} {\rm (p.\,\pageref{classost_1_1_buffer_9662e8def92667057121de0847dcabf0})}.\index{ost::FixedBuffer@{ost::Fixed\-Buffer}!operator=@{operator=}}
\index{operator=@{operator=}!ost::FixedBuffer@{ost::Fixed\-Buffer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Fixed\-Buffer}\& ost::Fixed\-Buffer::operator= (const {\bf Fixed\-Buffer} \& {\em fb})}\label{classost_1_1_fixed_buffer_5cba81d3c87bb5defc162bea91fba442}




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