<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Kyoto Cabinet: kyotocabinet::CondVar Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>::<a class="el" href="classkyotocabinet_1_1CondVar.html">CondVar</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::CondVar Class Reference</h1><!-- doxytag: class="kyotocabinet::CondVar" -->
<p>Condition variable.
<a href="#_details">More...</a></p>
<p><code>#include <kcthread.h></code></p>
<p><a href="classkyotocabinet_1_1CondVar-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CondVar.html#ab26f80626ff5b55365629a68be592b3e">CondVar</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ab26f80626ff5b55365629a68be592b3e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CondVar.html#aa9a6ae72fab7454c16a81ca1790c9e30">~CondVar</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa9a6ae72fab7454c16a81ca1790c9e30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CondVar.html#a57374e8d032ba00526a516b6e7e3218f">wait</a> (<a class="el" href="classkyotocabinet_1_1Mutex.html">Mutex</a> *mutex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for the signal. <a href="#a57374e8d032ba00526a516b6e7e3218f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CondVar.html#aeec95d1994700e3a6e704c54038a2bfd">wait</a> (<a class="el" href="classkyotocabinet_1_1Mutex.html">Mutex</a> *mutex, double sec)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for the signal. <a href="#aeec95d1994700e3a6e704c54038a2bfd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CondVar.html#a460512c8bd598b5cbd3955a07687bdb5">signal</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the wake-up signal to another waiting thread. <a href="#a460512c8bd598b5cbd3955a07687bdb5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CondVar.html#a36c12c7fbf47e11d3a8447fb81cd39e0">broadcast</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the wake-up signal to all waiting threads. <a href="#a36c12c7fbf47e11d3a8447fb81cd39e0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Condition variable. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab26f80626ff5b55365629a68be592b3e"></a><!-- doxytag: member="kyotocabinet::CondVar::CondVar" ref="ab26f80626ff5b55365629a68be592b3e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::CondVar::CondVar </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<a class="anchor" id="aa9a6ae72fab7454c16a81ca1790c9e30"></a><!-- doxytag: member="kyotocabinet::CondVar::~CondVar" ref="aa9a6ae72fab7454c16a81ca1790c9e30" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::CondVar::~CondVar </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a57374e8d032ba00526a516b6e7e3218f"></a><!-- doxytag: member="kyotocabinet::CondVar::wait" ref="a57374e8d032ba00526a516b6e7e3218f" args="(Mutex *mutex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::CondVar::wait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1Mutex.html">Mutex</a> * </td>
<td class="paramname"> <em>mutex</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for the signal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mutex</em> </td><td>a locked mutex. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aeec95d1994700e3a6e704c54038a2bfd"></a><!-- doxytag: member="kyotocabinet::CondVar::wait" ref="aeec95d1994700e3a6e704c54038a2bfd" args="(Mutex *mutex, double sec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CondVar::wait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1Mutex.html">Mutex</a> * </td>
<td class="paramname"> <em>mutex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>sec</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for the signal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mutex</em> </td><td>a locked mutex. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sec</em> </td><td>the interval of the suspension in seconds. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on catched signal, or false on timeout. </dd></dl>
</div>
</div>
<a class="anchor" id="a460512c8bd598b5cbd3955a07687bdb5"></a><!-- doxytag: member="kyotocabinet::CondVar::signal" ref="a460512c8bd598b5cbd3955a07687bdb5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::CondVar::signal </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send the wake-up signal to another waiting thread. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The mutex used for the wait method should be locked by the caller. </dd></dl>
</div>
</div>
<a class="anchor" id="a36c12c7fbf47e11d3a8447fb81cd39e0"></a><!-- doxytag: member="kyotocabinet::CondVar::broadcast" ref="a36c12c7fbf47e11d3a8447fb81cd39e0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::CondVar::broadcast </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send the wake-up signal to all waiting threads. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The mutex used for the wait method should be locked by the caller. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Dec 11 01:50:27 2010 for Kyoto Cabinet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
c07f89287b8745f052fcf9bc1067c5c0
>
files
>
55
