<!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::Thread 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_1Thread.html">Thread</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::Thread Class Reference</h1><!-- doxytag: class="kyotocabinet::Thread" -->
<p>Threading device.
<a href="#_details">More...</a></p>
<p><code>#include <kcthread.h></code></p>
<p><a href="classkyotocabinet_1_1Thread-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_1Thread.html#af3131d223a70be7fc2b13b3ca19236e9">Thread</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#af3131d223a70be7fc2b13b3ca19236e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1Thread.html#a441ab73a34913c61e28a9f3011a687bb">~Thread</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a441ab73a34913c61e28a9f3011a687bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1Thread.html#a1215f3d69811c25d69f1d32d80585402">run</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the concrete process. <a href="#a1215f3d69811c25d69f1d32d80585402"></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_1Thread.html#a2df1a9de056800ffe0c8512aa9d43a70">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start the thread. <a href="#a2df1a9de056800ffe0c8512aa9d43a70"></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_1Thread.html#a1a4f5e8ebcd2201a9078dd20407964d8">join</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for the thread to finish. <a href="#a1a4f5e8ebcd2201a9078dd20407964d8"></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_1Thread.html#a7676d477e98183da5740c9194988c2f0">detach</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put the thread in the detached state. <a href="#a7676d477e98183da5740c9194988c2f0"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1Thread.html#a9aba70b9f5075fe2ab121c8c35e141ce">exit</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminate the running thread. <a href="#a9aba70b9f5075fe2ab121c8c35e141ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1Thread.html#ad457f16aaa83d5dad249533790f28e2c">yield</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Yield the processor from the current thread. <a href="#ad457f16aaa83d5dad249533790f28e2c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1Thread.html#a65e09bd823274fcd6f999108b9ffadf0">sleep</a> (double sec)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Suspend execution of the current thread. <a href="#a65e09bd823274fcd6f999108b9ffadf0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1Thread.html#a32e3671a4355e060cc2bd1b02e3bcf0d">hash</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the hash value of the current thread. <a href="#a32e3671a4355e060cc2bd1b02e3bcf0d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Threading device. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af3131d223a70be7fc2b13b3ca19236e9"></a><!-- doxytag: member="kyotocabinet::Thread::Thread" ref="af3131d223a70be7fc2b13b3ca19236e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::Thread::Thread </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="a441ab73a34913c61e28a9f3011a687bb"></a><!-- doxytag: member="kyotocabinet::Thread::~Thread" ref="a441ab73a34913c61e28a9f3011a687bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual kyotocabinet::Thread::~Thread </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1215f3d69811c25d69f1d32d80585402"></a><!-- doxytag: member="kyotocabinet::Thread::run" ref="a1215f3d69811c25d69f1d32d80585402" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void kyotocabinet::Thread::run </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform the concrete process. </p>
</div>
</div>
<a class="anchor" id="a2df1a9de056800ffe0c8512aa9d43a70"></a><!-- doxytag: member="kyotocabinet::Thread::start" ref="a2df1a9de056800ffe0c8512aa9d43a70" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::Thread::start </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start the thread. </p>
</div>
</div>
<a class="anchor" id="a1a4f5e8ebcd2201a9078dd20407964d8"></a><!-- doxytag: member="kyotocabinet::Thread::join" ref="a1a4f5e8ebcd2201a9078dd20407964d8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::Thread::join </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for the thread to finish. </p>
</div>
</div>
<a class="anchor" id="a7676d477e98183da5740c9194988c2f0"></a><!-- doxytag: member="kyotocabinet::Thread::detach" ref="a7676d477e98183da5740c9194988c2f0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::Thread::detach </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put the thread in the detached state. </p>
</div>
</div>
<a class="anchor" id="a9aba70b9f5075fe2ab121c8c35e141ce"></a><!-- doxytag: member="kyotocabinet::Thread::exit" ref="a9aba70b9f5075fe2ab121c8c35e141ce" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void kyotocabinet::Thread::exit </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Terminate the running thread. </p>
</div>
</div>
<a class="anchor" id="ad457f16aaa83d5dad249533790f28e2c"></a><!-- doxytag: member="kyotocabinet::Thread::yield" ref="ad457f16aaa83d5dad249533790f28e2c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void kyotocabinet::Thread::yield </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Yield the processor from the current thread. </p>
</div>
</div>
<a class="anchor" id="a65e09bd823274fcd6f999108b9ffadf0"></a><!-- doxytag: member="kyotocabinet::Thread::sleep" ref="a65e09bd823274fcd6f999108b9ffadf0" args="(double sec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool kyotocabinet::Thread::sleep </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>sec</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Suspend execution of the current thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<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 success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a32e3671a4355e060cc2bd1b02e3bcf0d"></a><!-- doxytag: member="kyotocabinet::Thread::hash" ref="a32e3671a4355e060cc2bd1b02e3bcf0d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int64_t kyotocabinet::Thread::hash </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the hash value of the current thread. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the hash value of the current thread. </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
>
147
