tinykernel/docs/latex/classtk_1_1_mutex.tex

\doxysection{tk::Mutex クラス}
\label{classtk_1_1_mutex}\index{tk::Mutex@{tk::Mutex}}


所有権・優先度順ウェイクアップ・\+RAII 対応のミューテックス (排他ロック)  




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

\doxysubsubsection*{公開メンバ関数}
\begin{DoxyCompactItemize}
\item 
\textbf{ Mutex} ()=default
\item 
void \textbf{ lock} ()
\begin{DoxyCompactList}\small\item\em ミューテックスをロックします (空くまでブロック待機) \end{DoxyCompactList}\item 
bool \textbf{ try\+\_\+lock} ()
\begin{DoxyCompactList}\small\item\em ミューテックスのロックを試みます (ノンブロッキング) \end{DoxyCompactList}\item 
void \textbf{ unlock} ()
\begin{DoxyCompactList}\small\item\em ミューテックスのロックを解除します \end{DoxyCompactList}\item 
bool \textbf{ is\+\_\+locked} () const
\end{DoxyCompactItemize}


\doxysubsection{詳解}
所有権・優先度順ウェイクアップ・\+RAII 対応のミューテックス (排他ロック) 

共有リソースやペリフェラルへの同時アクセスを防止します。 ロックしたタスク本人以外の誤った {\ttfamily \doxyref{unlock()}{p.}{classtk_1_1_mutex_ae8d5dfd5655b5aa54d63db6e0cf2f707}} は安全に無視されます。 C++ の {\ttfamily Basic\+Lockable} を満たしており、{\ttfamily std::\+lock\+\_\+guard} や {\ttfamily \doxyref{tk::\+\+Lock\+Guard}{p.}{classtk_1_1_lock_guard}} が利用可能です。


\begin{DoxyCode}{0}
\DoxyCodeLine{tk::Mutex\ mtx;}
\DoxyCodeLine{}
\DoxyCodeLine{\{}
\DoxyCodeLine{\ \ \ \ tk::LockGuard<tk::Mutex>\ lock(mtx);}
\DoxyCodeLine{\ \ \ \ \textcolor{comment}{//\ クリティカルセクション...}}
\DoxyCodeLine{\}\ \textcolor{comment}{//\ 自動でアンロック}}

\end{DoxyCode}
 

\label{classtk_1_1_mutex_doc-constructors}
\doxysubsection{構築子と解体子}
\index{tk::Mutex@{tk::Mutex}!Mutex@{Mutex}}
\index{Mutex@{Mutex}!tk::Mutex@{tk::Mutex}}
\doxysubsubsection{Mutex()}
{\footnotesize\ttfamily \label{classtk_1_1_mutex_a8b17431db60f4ab48a3859b2ca722eb1} 
tk::\+\+Mutex::\+\+Mutex (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [default]}}



\label{classtk_1_1_mutex_doc-func-members}
\doxysubsection{関数詳解}
\index{tk::Mutex@{tk::Mutex}!is\_locked@{is\_locked}}
\index{is\_locked@{is\_locked}!tk::Mutex@{tk::Mutex}}
\doxysubsubsection{is\_locked()}
{\footnotesize\ttfamily \label{classtk_1_1_mutex_acf574e35540879481f1f6e5452a504ab} 
bool tk::\+\+Mutex::\+is\+\_\+locked (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}

現在ロックされているかどうかを判定 \index{tk::Mutex@{tk::Mutex}!lock@{lock}}
\index{lock@{lock}!tk::Mutex@{tk::Mutex}}
\doxysubsubsection{lock()}
{\footnotesize\ttfamily \label{classtk_1_1_mutex_a7f5645bba55df2db263f92a954802c27} 
void tk::\+\+Mutex::\+lock (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



ミューテックスをロックします (空くまでブロック待機) 

他のタスクが保持している場合は、解放されるまで自タスクを {\ttfamily State::\+\+Blocked} にして休止します。 \index{tk::Mutex@{tk::Mutex}!try\_lock@{try\_lock}}
\index{try\_lock@{try\_lock}!tk::Mutex@{tk::Mutex}}
\doxysubsubsection{try\_lock()}
{\footnotesize\ttfamily \label{classtk_1_1_mutex_a666dd03fb22c5cb855e3145f76a58b9c} 
bool tk::\+\+Mutex::\+try\+\_\+lock (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



ミューテックスのロックを試みます (ノンブロッキング) 

\begin{DoxyReturn}{戻り値}
true ロック獲得成功 

false 他のタスクが保持しているため獲得失敗 (ブロックせず即座に復帰) 
\end{DoxyReturn}
\index{tk::Mutex@{tk::Mutex}!unlock@{unlock}}
\index{unlock@{unlock}!tk::Mutex@{tk::Mutex}}
\doxysubsubsection{unlock()}
{\footnotesize\ttfamily \label{classtk_1_1_mutex_ae8d5dfd5655b5aa54d63db6e0cf2f707} 
void tk::\+\+Mutex::\+unlock (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



ミューテックスのロックを解除します 

ロックを保持しているタスク本人だけが解除できます。 待機中のタスクが存在する場合、最も優先度が高いタスクを 1 つ起床させます。 

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