classxapian_1_1internal_1_1refcntbase.tex

xapian 是一个“Xapian 是一个开源概率论信息检索库

\hypertarget{classXapian_1_1Internal_1_1RefCntBase}{
\section{Xapian::Internal::Ref\-Cnt\-Base Class Reference}
\label{classXapian_1_1Internal_1_1RefCntBase}\index{Xapian::Internal::RefCntBase@{Xapian::Internal::RefCntBase}}
}
Reference counted internal classes should inherit from \hyperlink{classXapian_1_1Internal_1_1RefCntBase}{Ref\-Cnt\-Base}.  


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

Inheritance diagram for Xapian::Internal::Ref\-Cnt\-Base:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=93pt]{classXapian_1_1Internal_1_1RefCntBase__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
\hypertarget{classXapian_1_1Internal_1_1RefCntBase_774fe8decf2205ec4bd31b7e8e49f7ff}{
typedef unsigned int {\bf ref\_\-count\_\-t}}
\label{classXapian_1_1Internal_1_1RefCntBase_774fe8decf2205ec4bd31b7e8e49f7ff}

\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hyperlink{classXapian_1_1Internal_1_1RefCntBase_1e12eac5645c570c38b52d16a16c2bd9}{Ref\-Cnt\-Base} ()
\begin{CompactList}\small\item\em The constructor, which initialises the ref\_\-count to 0. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
ref\_\-count\_\-t \hyperlink{classXapian_1_1Internal_1_1RefCntBase_726267073b695c25d5f963128483bdd2}{ref\_\-count}
\begin{CompactList}\small\item\em The actual reference count. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
\hyperlink{classXapian_1_1Internal_1_1RefCntBase_6fba6ec0895651ff292e4a3e3681517f}{Ref\-Cnt\-Base} (const \hyperlink{classXapian_1_1Internal_1_1RefCntBase}{Ref\-Cnt\-Base} \&)
\begin{CompactList}\small\item\em The copy constructor. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Reference counted internal classes should inherit from \hyperlink{classXapian_1_1Internal_1_1RefCntBase}{Ref\-Cnt\-Base}. 

This gives the object a reference count used by \hyperlink{classXapian_1_1Internal_1_1RefCntPtr}{Ref\-Cnt\-Ptr}. 



\subsection{Constructor \& Destructor Documentation}
\hypertarget{classXapian_1_1Internal_1_1RefCntBase_6fba6ec0895651ff292e4a3e3681517f}{
\index{Xapian::Internal::RefCntBase@{Xapian::Internal::Ref\-Cnt\-Base}!RefCntBase@{RefCntBase}}
\index{RefCntBase@{RefCntBase}!Xapian::Internal::RefCntBase@{Xapian::Internal::Ref\-Cnt\-Base}}
\subsubsection[RefCntBase]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Internal::Ref\-Cnt\-Base::Ref\-Cnt\-Base (const \hyperlink{classXapian_1_1Internal_1_1RefCntBase}{Ref\-Cnt\-Base} \&)\hspace{0.3cm}{\tt  \mbox{[}inline, protected\mbox{]}}}}
\label{classXapian_1_1Internal_1_1RefCntBase_6fba6ec0895651ff292e4a3e3681517f}


The copy constructor. 

This is protected since it'll only be used by derived classes, which should only rarely need copying (this is, after all, a refcount implementation). Sometimes it's needed, though, since we need to zero ref\_\-count in the copy. \hypertarget{classXapian_1_1Internal_1_1RefCntBase_1e12eac5645c570c38b52d16a16c2bd9}{
\index{Xapian::Internal::RefCntBase@{Xapian::Internal::Ref\-Cnt\-Base}!RefCntBase@{RefCntBase}}
\index{RefCntBase@{RefCntBase}!Xapian::Internal::RefCntBase@{Xapian::Internal::Ref\-Cnt\-Base}}
\subsubsection[RefCntBase]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Internal::Ref\-Cnt\-Base::Ref\-Cnt\-Base ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1Internal_1_1RefCntBase_1e12eac5645c570c38b52d16a16c2bd9}


The constructor, which initialises the ref\_\-count to 0. 



\subsection{Member Data Documentation}
\hypertarget{classXapian_1_1Internal_1_1RefCntBase_726267073b695c25d5f963128483bdd2}{
\index{Xapian::Internal::RefCntBase@{Xapian::Internal::Ref\-Cnt\-Base}!ref_count@{ref\_\-count}}
\index{ref_count@{ref\_\-count}!Xapian::Internal::RefCntBase@{Xapian::Internal::Ref\-Cnt\-Base}}
\subsubsection[ref\_\-count]{\setlength{\rightskip}{0pt plus 5cm}ref\_\-count\_\-t \hyperlink{classXapian_1_1Internal_1_1RefCntBase_726267073b695c25d5f963128483bdd2}{Xapian::Internal::Ref\-Cnt\-Base::ref\_\-count}\hspace{0.3cm}{\tt  \mbox{[}mutable\mbox{]}}}}
\label{classXapian_1_1Internal_1_1RefCntBase_726267073b695c25d5f963128483bdd2}


The actual reference count. 

It's mutable so we can have reference counting work with const pointers. 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
include/xapian/base.h\end{CompactItemize}