135 lines
6.3 KiB
TeX
135 lines
6.3 KiB
TeX
\doxysection{Lockable\+DObject Class Reference}
|
|
\hypertarget{class_lockable_d_object}{}\label{class_lockable_d_object}\index{LockableDObject@{LockableDObject}}
|
|
|
|
|
|
Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$Lockable\+DObject.\+h$>$}
|
|
|
|
\doxysubsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}{Lockable\+DObject}} ()=default
|
|
\begin{DoxyCompactList}\small\item\em Default constructor. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{class_d_object}{DObject}} \& \mbox{\hyperlink{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}{get}} ()
|
|
\begin{DoxyCompactList}\small\item\em Access the underlying \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}{lock}} ()
|
|
\begin{DoxyCompactList}\small\item\em Locks the mutex to ensure thread-\/safe access. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}{unlock}} ()
|
|
\begin{DoxyCompactList}\small\item\em Unlocks the mutex after thread-\/safe access. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{class_d_object}{DObject}} \mbox{\hyperlink{class_lockable_d_object_a1eb1ca1d9cf979dcb9eead96054b89bb}{object\+\_\+}}
|
|
\begin{DoxyCompactList}\small\item\em The underlying \doxylink{class_d_object}{DObject} instance. \end{DoxyCompactList}\item
|
|
std\+::mutex \mbox{\hyperlink{class_lockable_d_object_a712cd3ea0c565f7e9089a651ef79b7bd}{mutex\+\_\+}}
|
|
\begin{DoxyCompactList}\small\item\em Mutex for thread-\/safe access. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access.
|
|
|
|
Definition at line \mbox{\hyperlink{_lockable_d_object_8h_source_l00039}{39}} of file \mbox{\hyperlink{_lockable_d_object_8h_source}{Lockable\+DObject.\+h}}.
|
|
|
|
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\Hypertarget{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}\index{LockableDObject@{LockableDObject}!LockableDObject@{LockableDObject}}
|
|
\index{LockableDObject@{LockableDObject}!LockableDObject@{LockableDObject}}
|
|
\doxysubsubsection{\texorpdfstring{LockableDObject()}{LockableDObject()}}
|
|
{\footnotesize\ttfamily \label{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}
|
|
Lockable\+DObject\+::\+Lockable\+DObject (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}}
|
|
|
|
|
|
|
|
Default constructor.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\Hypertarget{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}\index{LockableDObject@{LockableDObject}!get@{get}}
|
|
\index{get@{get}!LockableDObject@{LockableDObject}}
|
|
\doxysubsubsection{\texorpdfstring{get()}{get()}}
|
|
{\footnotesize\ttfamily \label{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}
|
|
\mbox{\hyperlink{class_d_object}{DObject}} \& Lockable\+DObject\+::get (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Access the underlying \doxylink{class_d_object}{DObject}.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
A reference to the wrapped \doxylink{class_d_object}{DObject}.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{_lockable_d_object_8cpp_source_l00026}{26}} of file \mbox{\hyperlink{_lockable_d_object_8cpp_source}{Lockable\+DObject.\+cpp}}.
|
|
|
|
\Hypertarget{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}\index{LockableDObject@{LockableDObject}!lock@{lock}}
|
|
\index{lock@{lock}!LockableDObject@{LockableDObject}}
|
|
\doxysubsubsection{\texorpdfstring{lock()}{lock()}}
|
|
{\footnotesize\ttfamily \label{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}
|
|
void Lockable\+DObject\+::lock (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Locks the mutex to ensure thread-\/safe access.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{_lockable_d_object_8cpp_source_l00033}{33}} of file \mbox{\hyperlink{_lockable_d_object_8cpp_source}{Lockable\+DObject.\+cpp}}.
|
|
|
|
\Hypertarget{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}\index{LockableDObject@{LockableDObject}!unlock@{unlock}}
|
|
\index{unlock@{unlock}!LockableDObject@{LockableDObject}}
|
|
\doxysubsubsection{\texorpdfstring{unlock()}{unlock()}}
|
|
{\footnotesize\ttfamily \label{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}
|
|
void Lockable\+DObject\+::unlock (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Unlocks the mutex after thread-\/safe access.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{_lockable_d_object_8cpp_source_l00040}{40}} of file \mbox{\hyperlink{_lockable_d_object_8cpp_source}{Lockable\+DObject.\+cpp}}.
|
|
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\Hypertarget{class_lockable_d_object_a712cd3ea0c565f7e9089a651ef79b7bd}\index{LockableDObject@{LockableDObject}!mutex\_@{mutex\_}}
|
|
\index{mutex\_@{mutex\_}!LockableDObject@{LockableDObject}}
|
|
\doxysubsubsection{\texorpdfstring{mutex\_}{mutex\_}}
|
|
{\footnotesize\ttfamily \label{class_lockable_d_object_a712cd3ea0c565f7e9089a651ef79b7bd}
|
|
std\+::mutex Lockable\+DObject\+::mutex\+\_\+\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
Mutex for thread-\/safe access.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{_lockable_d_object_8h_source_l00064}{64}} of file \mbox{\hyperlink{_lockable_d_object_8h_source}{Lockable\+DObject.\+h}}.
|
|
|
|
\Hypertarget{class_lockable_d_object_a1eb1ca1d9cf979dcb9eead96054b89bb}\index{LockableDObject@{LockableDObject}!object\_@{object\_}}
|
|
\index{object\_@{object\_}!LockableDObject@{LockableDObject}}
|
|
\doxysubsubsection{\texorpdfstring{object\_}{object\_}}
|
|
{\footnotesize\ttfamily \label{class_lockable_d_object_a1eb1ca1d9cf979dcb9eead96054b89bb}
|
|
\mbox{\hyperlink{class_d_object}{DObject}} Lockable\+DObject\+::object\+\_\+\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
The underlying \doxylink{class_d_object}{DObject} instance.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{_lockable_d_object_8h_source_l00063}{63}} of file \mbox{\hyperlink{_lockable_d_object_8h_source}{Lockable\+DObject.\+h}}.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
src/dobj/public/\mbox{\hyperlink{_lockable_d_object_8h}{Lockable\+DObject.\+h}}\item
|
|
src/dobj/private/\mbox{\hyperlink{_lockable_d_object_8cpp}{Lockable\+DObject.\+cpp}}\end{DoxyCompactItemize}
|