<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<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>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Kyoto Cabinet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a> </li>
<li class="navelem"><a class="el" href="classkyotocabinet_1_1TaskQueue.html">TaskQueue</a> </li>
<li class="navelem"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html">Task</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">kyotocabinet::TaskQueue::Task Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="kyotocabinet::TaskQueue::Task" -->
<p>Interface of a task.
<a href="classkyotocabinet_1_1TaskQueue_1_1Task.html#details">More...</a></p>
<p><code>#include <kcthread.h></code></p>
<p><a href="classkyotocabinet_1_1TaskQueue_1_1Task-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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_1TaskQueue_1_1Task.html#accc732e76aaab806a9235494c48d519d">Task</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#accc732e76aaab806a9235494c48d519d"></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_1TaskQueue_1_1Task.html#a14da6c01e17d625ce136f55284281477">~Task</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a14da6c01e17d625ce136f55284281477"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a4cabfcaef3c19deba55f2e1384490fb4">id</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ID number of the task. <a href="#a4cabfcaef3c19deba55f2e1384490fb4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a30d4b82f61bdc09546e137c43c5341b8">thread_id</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ID number of the worker thread. <a href="#a30d4b82f61bdc09546e137c43c5341b8"></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_1TaskQueue_1_1Task.html#a1b0cc10973f69504109bfb15c1c07aca">aborted</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether the thread is to be aborted. <a href="#a1b0cc10973f69504109bfb15c1c07aca"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
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 </td><td class="memItemRight" valign="bottom"><b>TaskQueue</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface of a task. </p>
</div><hr/><h2>Constructor & 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"><a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#accc732e76aaab806a9235494c48d519d">kyotocabinet::TaskQueue::Task::Task</a> </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="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 <a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a14da6c01e17d625ce136f55284281477">kyotocabinet::TaskQueue::Task::~Task</a> </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="a4cabfcaef3c19deba55f2e1384490fb4"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::id" ref="a4cabfcaef3c19deba55f2e1384490fb4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t <a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a4cabfcaef3c19deba55f2e1384490fb4">kyotocabinet::TaskQueue::Task::id</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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="a30d4b82f61bdc09546e137c43c5341b8"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::thread_id" ref="a30d4b82f61bdc09546e137c43c5341b8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a30d4b82f61bdc09546e137c43c5341b8">kyotocabinet::TaskQueue::Task::thread_id</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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="a1b0cc10973f69504109bfb15c1c07aca"></a><!-- doxytag: member="kyotocabinet::TaskQueue::Task::aborted" ref="a1b0cc10973f69504109bfb15c1c07aca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1TaskQueue_1_1Task.html#a1b0cc10973f69504109bfb15c1c07aca">kyotocabinet::TaskQueue::Task::aborted</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
