tinykernel/docs/latex/classtk_1_1_lock_guard.tex

\doxysection{tk::Lock\+Guard$<$ Lockable $>$ クラステンプレート}
\label{classtk_1_1_lock_guard}\index{tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}}


ミューテックスのロックをスコープ単位で安全に管理する RAII クラス (std::\+lock\+\_\+guard 相当)  




{\ttfamily \+\#include $<$sync.\+hpp$>$}

\doxysubsubsection*{公開メンバ関数}
\begin{DoxyCompactItemize}
\item 
\textbf{ Lock\+Guard} (Lockable \&m)
\begin{DoxyCompactList}\small\item\em ロック対象を受け取り、即座に \doxyref{lock()}{p.}{namespacetk_a6540aa25eb8562f6d6c8b37977d6cfe8} します \end{DoxyCompactList}\item 
\textbf{ $\sim$\+Lock\+Guard} ()
\item 
\textbf{ Lock\+Guard} (const Lock\+Guard \&)=delete
\item 
\textbf{ Lock\+Guard} \& \textbf{ operator=} (const \textbf{ Lock\+Guard} \&)=delete
\end{DoxyCompactItemize}


\doxysubsection{詳解}
\subsubsection*{template$<$typename Lockable$>$\newline
class tk::\+\+Lock\+Guard$<$ Lockable $>$}
ミューテックスのロックをスコープ単位で安全に管理する RAII クラス (std::\+lock\+\_\+guard 相当) 

構築時に {\ttfamily \doxyref{lock()}{p.}{namespacetk_a6540aa25eb8562f6d6c8b37977d6cfe8}} を呼び、デストラクタで自動的に {\ttfamily \doxyref{unlock()}{p.}{namespacetk_a752b12f6862815c94a52347af52578b7}} を呼び出します。 途中で return や例外が発生しても確実にロックが解放されます。


\begin{DoxyTemplParams}{テンプレート引数}
{\em Lockable} & \doxyref{lock()}{p.}{namespacetk_a6540aa25eb8562f6d6c8b37977d6cfe8} と \doxyref{unlock()}{p.}{namespacetk_a752b12f6862815c94a52347af52578b7} を持つ型 (例: \doxyref{tk::\+\+Mutex}{p.}{classtk_1_1_mutex}) \\
\hline
\end{DoxyTemplParams}


\label{classtk_1_1_lock_guard_doc-constructors}
\doxysubsection{構築子と解体子}
\index{tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}!LockGuard@{LockGuard}}
\index{LockGuard@{LockGuard}!tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}}
\doxysubsubsection{LockGuard()\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{classtk_1_1_lock_guard_a3a922c7edf84ce25ef67151c322bb0eb} 
template$<$typename Lockable$>$ \\
\textbf{ tk::\+\+Lock\+Guard}$<$ Lockable $>$::\+\+Lock\+Guard (\begin{DoxyParamCaption}\item[{Lockable \&}]{m}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [explicit]}}



ロック対象を受け取り、即座に \doxyref{lock()}{p.}{namespacetk_a6540aa25eb8562f6d6c8b37977d6cfe8} します 


\begin{DoxyParams}{引数}
{\em m} & ロック対象のミューテックス参照 \\
\hline
\end{DoxyParams}
\index{tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}!````~LockGuard@{$\sim$LockGuard}}
\index{````~LockGuard@{$\sim$LockGuard}!tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}}
\doxysubsubsection{$\sim$LockGuard()}
{\footnotesize\ttfamily \label{classtk_1_1_lock_guard_a52eeb50abee00bd0ed16cfa6618ce40f} 
template$<$typename Lockable$>$ \\
\textbf{ tk::\+\+Lock\+Guard}$<$ Lockable $>$::\+$\sim$\textbf{ Lock\+Guard} (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

スコープ終了時に自動的に \doxyref{unlock()}{p.}{namespacetk_a752b12f6862815c94a52347af52578b7} します \index{tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}!LockGuard@{LockGuard}}
\index{LockGuard@{LockGuard}!tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}}
\doxysubsubsection{LockGuard()\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{classtk_1_1_lock_guard_af9bc86bc2036c4b8e54633ddee811604} 
template$<$typename Lockable$>$ \\
\textbf{ tk::\+\+Lock\+Guard}$<$ Lockable $>$::\+\+Lock\+Guard (\begin{DoxyParamCaption}\item[{const Lock\+Guard$<$ Lockable $>$ \&}]{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}}



\label{classtk_1_1_lock_guard_doc-func-members}
\doxysubsection{関数詳解}
\index{tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}!operator=@{operator=}}
\index{operator=@{operator=}!tk::LockGuard$<$ Lockable $>$@{tk::LockGuard$<$ Lockable $>$}}
\doxysubsubsection{operator=()}
{\footnotesize\ttfamily \label{classtk_1_1_lock_guard_a3f121f8aa1307f0f6e6e608cf138340c} 
template$<$typename Lockable$>$ \\
\textbf{ Lock\+Guard} \& \textbf{ tk::\+\+Lock\+Guard}$<$ Lockable $>$::\+operator= (\begin{DoxyParamCaption}\item[{const \textbf{ Lock\+Guard}$<$ Lockable $>$ \&}]{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [delete]}}



このクラス詳解は次のファイルから抽出されました:\begin{DoxyCompactItemize}
\item 
C:\+/\+\+Users/\+yoneda/\+\+Documents/\+\+Pico\+\_\+\+Projects/\+tinykernel/\+tinykernel/\+include/\+tinykernel/\textbf{ sync.\+hpp}\end{DoxyCompactItemize}