Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > c07f89287b8745f052fcf9bc1067c5c0 > files > 145

kyotocabinet-1.2.29-1.fc14.x86_64.rpm

<!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::TaskQueue::Task 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>::<a class="el" href="classkyotocabinet_1_1TaskQueue.html">TaskQueue</a>::<a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html">Task</a>
  </div>
</div>
<div class="contents">
<h1>kyotocabinet::TaskQueue::Task Class Reference</h1><!-- doxytag: class="kyotocabinet::TaskQueue::Task" -->
<p>Interface of a task.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;kcthread.h&gt;</code></p>

<p><a href="classkyotocabinet_1_1TaskQueue_1_1Task-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#accc732e76aaab806a9235494c48d519d">Task</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#accc732e76aaab806a9235494c48d519d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a14da6c01e17d625ce136f55284281477">~Task</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#a14da6c01e17d625ce136f55284281477"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a2ee20a5f7490ec9a9ba11bcd4ce23da4">id</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the ID number of the task.  <a href="#a2ee20a5f7490ec9a9ba11bcd4ce23da4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a24ef2a1c51d85c45a9b53572aa8b064d">thread_id</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the ID number of the worker thread.  <a href="#a24ef2a1c51d85c45a9b53572aa8b064d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a3a9bfe989436a78c7b51d25b6b00fe3e">aborted</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check whether the thread is to be aborted.  <a href="#a3a9bfe989436a78c7b51d25b6b00fe3e"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae130f9d4321eb1bfe554e67c3a5e2040"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::TaskQueue" ref="ae130f9d4321eb1bfe554e67c3a5e2040" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>TaskQueue</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Interface of a task. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="accc732e76aaab806a9235494c48d519d"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::Task" ref="accc732e76aaab806a9235494c48d519d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">kyotocabinet::TaskQueue::Task::Task </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a class="anchor" id="a14da6c01e17d625ce136f55284281477"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::~Task" ref="a14da6c01e17d625ce136f55284281477" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual kyotocabinet::TaskQueue::Task::~Task </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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="a2ee20a5f7490ec9a9ba11bcd4ce23da4"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::id" ref="a2ee20a5f7490ec9a9ba11bcd4ce23da4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t kyotocabinet::TaskQueue::Task::id </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the ID number of the task. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the ID number of the task, which is incremented from 1. </dd></dl>

</div>
</div>
<a class="anchor" id="a24ef2a1c51d85c45a9b53572aa8b064d"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::thread_id" ref="a24ef2a1c51d85c45a9b53572aa8b064d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t kyotocabinet::TaskQueue::Task::thread_id </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the ID number of the worker thread. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the ID number of the worker thread. It is from 0 to less than the number of worker threads. </dd></dl>

</div>
</div>
<a class="anchor" id="a3a9bfe989436a78c7b51d25b6b00fe3e"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::aborted" ref="a3a9bfe989436a78c7b51d25b6b00fe3e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool kyotocabinet::TaskQueue::Task::aborted </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Check whether the thread is to be aborted. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the thread is to be aborted, or false if not. </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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>