Sophie

Sophie

distrib > Mandriva > 2007.0 > i586 > by-pkgid > ad1ba1135a9c9eeffc2e538163e00373 > files > 750

libCommonC++2_1.4-devel-1.4.1-1mdv2007.0.i586.rpm

\section{ost::Shared\-Mem\-Pager Class Reference}
\label{classost_1_1_shared_mem_pager}\index{ost::SharedMemPager@{ost::SharedMemPager}}
The shared mempager uses a mutex to protect key access methods.mutex protected memory pager.  


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

Inheritance diagram for ost::Shared\-Mem\-Pager::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classost_1_1_shared_mem_pager}
\end{center}
\end{figure}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf Shared\-Mem\-Pager} (size\_\-t pagesize=4096, const char $\ast$name=NULL)
\begin{CompactList}\small\item\em Create a mempager mutex pool. \item\end{CompactList}\item 
void {\bf purge} (void)
\begin{CompactList}\small\item\em Purge the memory pool while locked. \item\end{CompactList}\item 
void $\ast$ {\bf first} (size\_\-t size)
\begin{CompactList}\small\item\em Get the first memory page after locking. \item\end{CompactList}\item 
void $\ast$ {\bf alloc} (size\_\-t size)
\begin{CompactList}\small\item\em Get the last memory page after locking. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
The shared mempager uses a mutex to protect key access methods.mutex protected memory pager. 

This class is used when a mempager will be shared by multiple threads.

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




\subsection{Constructor \& Destructor Documentation}
\index{ost::SharedMemPager@{ost::Shared\-Mem\-Pager}!SharedMemPager@{SharedMemPager}}
\index{SharedMemPager@{SharedMemPager}!ost::SharedMemPager@{ost::Shared\-Mem\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Shared\-Mem\-Pager::Shared\-Mem\-Pager (size\_\-t {\em pagesize} = {\tt 4096}, const char $\ast$ {\em name} = {\tt NULL})\hspace{0.3cm}{\tt  [protected]}}\label{classost_1_1_shared_mem_pager_6914e160b526068c31c0086134cbfbac}


Create a mempager mutex pool. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em pagesize}]page size for allocation. \item[{\em name}]a name for the pool. \end{description}
\end{Desc}


\subsection{Member Function Documentation}
\index{ost::SharedMemPager@{ost::Shared\-Mem\-Pager}!alloc@{alloc}}
\index{alloc@{alloc}!ost::SharedMemPager@{ost::Shared\-Mem\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ ost::Shared\-Mem\-Pager::alloc (size\_\-t {\em size})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classost_1_1_shared_mem_pager_d5c3aad294fd247a972a72983dcf831b}


Get the last memory page after locking. 

\begin{Desc}
\item[Returns:]allocated memory space. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]of request. \end{description}
\end{Desc}


Reimplemented from {\bf ost::Mem\-Pager} {\rm (p.\,\pageref{classost_1_1_mem_pager_3a03cb50bd4084ddbf6314ec0339d176})}.\index{ost::SharedMemPager@{ost::Shared\-Mem\-Pager}!first@{first}}
\index{first@{first}!ost::SharedMemPager@{ost::Shared\-Mem\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ ost::Shared\-Mem\-Pager::first (size\_\-t {\em size})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classost_1_1_shared_mem_pager_644a00d48052aff83a180523b205aa6f}


Get the first memory page after locking. 

\begin{Desc}
\item[Returns:]allocated memory space. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]of request. \end{description}
\end{Desc}


Reimplemented from {\bf ost::Mem\-Pager} {\rm (p.\,\pageref{classost_1_1_mem_pager_2c82ac4c97fcba81c643966973e78d84})}.\index{ost::SharedMemPager@{ost::Shared\-Mem\-Pager}!purge@{purge}}
\index{purge@{purge}!ost::SharedMemPager@{ost::Shared\-Mem\-Pager}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Shared\-Mem\-Pager::purge (void)\hspace{0.3cm}{\tt  [protected]}}\label{classost_1_1_shared_mem_pager_fafb0b8ce31a2b1fdee64a5a9cadebc6}


Purge the memory pool while locked. 



Reimplemented from {\bf ost::Mem\-Pager} {\rm (p.\,\pageref{classost_1_1_mem_pager_5bfdb6f2d6f569ba08c32c59efb3a012})}.

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