Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 98d6b53e11e983e268c3e19f14e091a0 > files > 4192

kdepim-devel-doc-3.5.9-9mdv2008.1.x86_64.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en_US" xml:lang="en_US">

<head>
  <title>libkdepim: KPIM::ThreadWeaver::Thread Class Reference (libkdepim)</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  <meta http-equiv="Content-Style-Type" content="text/css" />

  <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org"  r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org"  r (n 0 s 0 v 0 l 0))' />

  <meta name="trademark" content="KDE e.V." />
  <meta name="description" content="K Desktop Environment Homepage, KDE.org" />
  <meta name="MSSmartTagsPreventParsing" content="true" />
  <meta name="robots" content="all" />

  <link rel="shortcut icon" href="../../favicon.ico" />

<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />



<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020;  }

-->
</style>

</head>

<body>

<div id="nav_header_top" align="right">
  <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>

  <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
  <span class="doNotDisplay">::</span>
  <img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" />

  <div id="nav_header_title" align="left">KDE PIM API Reference</div>


</div>

<div id="nav_header_bottom" align="right">
  <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
  <div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../">API Reference</a>
 / <a href=".">libkdepim</a>
  </div>
</div>


<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
      <td valign="top" class="menuheader" height="0"></td>

  <td id="contentcolumn" valign="top" rowspan="2" >
    <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
    <h2><a name="content"></a>libkdepim</h2>


<!-- Generated by Doxygen 1.5.5 -->
  <div class="navpath"><a class="el" href="namespaceKPIM.html">KPIM</a>::<b>ThreadWeaver</b>::<a class="el" href="classKPIM_1_1ThreadWeaver_1_1Thread.html">Thread</a>
  </div>
<div class="contents">
<h1>KPIM::ThreadWeaver::Thread Class Reference</h1><!-- doxytag: class="KPIM::ThreadWeaver::Thread" --><!-- doxytag: inherits="QThread" --><code>#include &lt;<a class="el" href="weaver_8h-source.html">weaver.h</a>&gt;</code>
<p>
Inherits QThread.
<p>

<p>
<a href="classKPIM_1_1ThreadWeaver_1_1Thread-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The class <a class="el" href="classKPIM_1_1ThreadWeaver_1_1Thread.html" title="The class Thread is used to represent the worker threads in the weaver&#39;s inventory...">Thread</a> is used to represent the worker threads in the weaver's inventory. 
<p>
It is not meant to be overloaded. 
<p>Definition at line <a class="el" href="weaver_8h-source.html#l00249">249</a> of file <a class="el" href="weaver_8h-source.html">weaver.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ThreadWeaver_1_1Thread.html#31e631ae6d49af500c73f5de317e0830">Thread</a> (<a class="el" href="classKPIM_1_1ThreadWeaver_1_1Weaver.html">Weaver</a> *parent)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ThreadWeaver_1_1Thread.html#c0c94012e2d8b176d92bc14588b91469">~Thread</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ThreadWeaver_1_1Thread.html#8d7972953a2f94e81127cb7cbb4f659e">run</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aeed2a9d0e556a6f0322dec5783ea507"></a><!-- doxytag: member="KPIM::ThreadWeaver::Thread::msleep" ref="aeed2a9d0e556a6f0322dec5783ea507" args="(unsigned long msec)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>msleep</b> (unsigned long msec)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ThreadWeaver_1_1Thread.html#429599fda21981785b09c2c3100ce001">id</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ThreadWeaver_1_1Thread.html#a4970687383e115237fb02de469034f6">post</a> (<a class="el" href="classKPIM_1_1ThreadWeaver_1_1Event.html#a9901c5a6c6973f42722a32b13a3c219">Event::Action</a>, <a class="el" href="classKPIM_1_1ThreadWeaver_1_1Job.html">Job</a> *=0)</td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="31e631ae6d49af500c73f5de317e0830"></a><!-- doxytag: member="KPIM::ThreadWeaver::Thread::Thread" ref="31e631ae6d49af500c73f5de317e0830" args="(Weaver *parent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KPIM::ThreadWeaver::Thread::Thread           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classKPIM_1_1ThreadWeaver_1_1Weaver.html">Weaver</a> *&nbsp;</td>
          <td class="paramname"> <em>parent</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a thread. 
<p>
These thread objects are only used inside the <a class="el" href="classKPIM_1_1ThreadWeaver_1_1Weaver.html" title="A weaver is the manager of worker threads (Thread objects) to which it assigns jobs...">Weaver</a> parent object. 
<p>Definition at line <a class="el" href="weaver_8cpp-source.html#l00181">181</a> of file <a class="el" href="weaver_8cpp-source.html">weaver.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="c0c94012e2d8b176d92bc14588b91469"></a><!-- doxytag: member="KPIM::ThreadWeaver::Thread::~Thread" ref="c0c94012e2d8b176d92bc14588b91469" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KPIM::ThreadWeaver::Thread::~Thread           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The destructor. 
<p>

<p>Definition at line <a class="el" href="weaver_8cpp-source.html#l00188">188</a> of file <a class="el" href="weaver_8cpp-source.html">weaver.cpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8d7972953a2f94e81127cb7cbb4f659e"></a><!-- doxytag: member="KPIM::ThreadWeaver::Thread::run" ref="8d7972953a2f94e81127cb7cbb4f659e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ThreadWeaver::Thread::run           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Overloaded to execute the assigned job. 
<p>
This will NOT return until shutdown() is called. The thread will try to execute one job after the other, asking the <a class="el" href="classKPIM_1_1ThreadWeaver_1_1Weaver.html" title="A weaver is the manager of worker threads (Thread objects) to which it assigns jobs...">Weaver</a> parent for a new job when the assigned one is finished. If no jobs are available, the thread will suspend. After shutdown() is called, the thread will end as soon as the currently assigned job is done. 
<p>Definition at line <a class="el" href="weaver_8cpp-source.html#l00205">205</a> of file <a class="el" href="weaver_8cpp-source.html">weaver.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="429599fda21981785b09c2c3100ce001"></a><!-- doxytag: member="KPIM::ThreadWeaver::Thread::id" ref="429599fda21981785b09c2c3100ce001" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int KPIM::ThreadWeaver::Thread::id           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the thread id. 
<p>
This id marks the respective <a class="el" href="classKPIM_1_1ThreadWeaver_1_1Thread.html" title="The class Thread is used to represent the worker threads in the weaver&#39;s inventory...">Thread</a> object, and must therefore not be confused with, e.g., the pthread thread ID. 
<p>Definition at line <a class="el" href="weaver_8cpp-source.html#l00200">200</a> of file <a class="el" href="weaver_8cpp-source.html">weaver.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="a4970687383e115237fb02de469034f6"></a><!-- doxytag: member="KPIM::ThreadWeaver::Thread::post" ref="a4970687383e115237fb02de469034f6" args="(Event::Action, Job *=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ThreadWeaver::Thread::post           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classKPIM_1_1ThreadWeaver_1_1Event.html#a9901c5a6c6973f42722a32b13a3c219">Event::Action</a>&nbsp;</td>
          <td class="paramname"> <em>a</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classKPIM_1_1ThreadWeaver_1_1Job.html">Job</a> *&nbsp;</td>
          <td class="paramname"> <em>j</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Post an event, will be received and processed by the <a class="el" href="classKPIM_1_1ThreadWeaver_1_1Weaver.html" title="A weaver is the manager of worker threads (Thread objects) to which it assigns jobs...">Weaver</a>. 
<p>

<p>Definition at line <a class="el" href="weaver_8cpp-source.html#l00230">230</a> of file <a class="el" href="weaver_8cpp-source.html">weaver.cpp</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="weaver_8h-source.html">weaver.h</a><li><a class="el" href="weaver_8cpp-source.html">weaver.cpp</a></ul>
</div>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>libkdepim</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
  <option value="classActionBase.html">actionbase</option>,  <option value="classActionEditWidget.html">actioneditwidget</option>,  <option value="classAlarmClient.html">alarmclient</option>,  <option value="classConditionEditWidget.html">conditioneditwidget</option>,  <option value="classGroupItem.html">groupitem</option>,  <option value="classKABC_1_1ResourceNull.html">kabc::resourcenull</option>,  <option value="classKConfigWizard.html">kconfigwizard</option>,  <option value="classKDateEdit.html">kdateedit</option>,  <option value="classKDatePickerPopup.html">kdatepickerpopup</option>,  <option value="classKIncidenceChooser.html">kincidencechooser</option>,  <option value="classKomposer_1_1Core.html">komposer::core</option>,  <option value="classKomposer_1_1KomposerIface.html">komposer::komposeriface</option>,  <option value="classKParts_1_1InfoExtension.html">kparts::infoextension</option>,  <option value="classKParts_1_1SideBarExtension.html">kparts::sidebarextension</option>,  <option value="classKPartsGenericPart.html">kpartsgenericpart</option>,  <option value="classKPartsWidgetPlugin.html">kpartswidgetplugin</option>,  <option value="classKPIM_1_1BroadcastStatus.html">kpim::broadcaststatus</option>,  <option value="classKPIM_1_1ClickLineEdit.html">kpim::clicklineedit</option>,  <option value="classKPIM_1_1CollectingProcess.html">kpim::collectingprocess</option>,  <option value="classKPIM_1_1ConfigManager.html">kpim::configmanager</option>,  <option value="classKPIM_1_1DiffAlgoDisplay.html">kpim::diffalgodisplay</option>,  <option value="classKPIM_1_1DistributionList.html">kpim::distributionlist</option>,  <option value="classKPIM_1_1KMailCompletion.html">kpim::kmailcompletion</option>,  <option value="classKPIM_1_1KPixmapRegionSelectorDialog.html">kpim::kpixmapregionselectordialog</option>,  <option value="classKPIM_1_1KPixmapRegionSelectorWidget.html">kpim::kpixmapregionselectorwidget</option>,  <option value="classKPIM_1_1LdapClient.html">kpim::ldapclient</option>,  <option value="classKPIM_1_1LdapObject.html">kpim::ldapobject</option>,  <option value="classKPIM_1_1LdapSearch.html">kpim::ldapsearch</option>,  <option value="classKPIM_1_1OverlayWidget.html">kpim::overlaywidget</option>,  <option value="classKPIM_1_1PluginLoader.html">kpim::pluginloader</option>,  <option value="classKPIM_1_1ProgressManager.html">kpim::progressmanager</option>,  <option value="classKPIM_1_1ResourceABC.html">kpim::resourceabc</option>,  <option value="classKPIM_1_1SelectionItem.html">kpim::selectionitem</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1Event.html">kpim::threadweaver::event</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1Job.html">kpim::threadweaver::job</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1Thread.html">kpim::threadweaver::thread</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1Weaver.html">kpim::threadweaver::weaver</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1WeaverExtension.html">kpim::threadweaver::weaverextension</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1WeaverThreadLogger.html">kpim::threadweaver::weaverthreadlogger</option>,  <option value="classKPrefsDialog.html">kprefsdialog</option>,  <option value="classKPrefsWid.html">kprefswid</option>,  <option value="classKPrefsWidBool.html">kprefswidbool</option>,  <option value="classKPrefsWidColor.html">kprefswidcolor</option>,  <option value="classKPrefsWidCombo.html">kprefswidcombo</option>,  <option value="classKPrefsWidDate.html">kprefswiddate</option>,  <option value="classKPrefsWidDuration.html">kprefswidduration</option>,  <option value="classKPrefsWidFont.html">kprefswidfont</option>,  <option value="classKPrefsWidInt.html">kprefswidint</option>,  <option value="classKPrefsWidManager.html">kprefswidmanager</option>,  <option value="classKPrefsWidPath.html">kprefswidpath</option>,  <option value="classKPrefsWidRadios.html">kprefswidradios</option>,  <option value="classKPrefsWidString.html">kprefswidstring</option>,  <option value="classKPrefsWidTime.html">kprefswidtime</option>,  <option value="classKRecentAddress_1_1RecentAddresses.html">krecentaddress::recentaddresses</option>,  <option value="classKRegExp3.html">kregexp3</option>,  <option value="classKResourcePrefs.html">kresourceprefs</option>,  <option value="classKRSqueezedTextLabel.html">krsqueezedtextlabel</option>,  <option value="classKSubscription.html">ksubscription</option>,  <option value="classKTimeEdit.html">ktimeedit</option>,  <option value="classKVCardDrag.html">kvcarddrag</option>,  <option value="classKWidgetLister.html">kwidgetlister</option>,  <option value="classLinkLocator.html">linklocator</option>,  <option value="classQStrictUtf7Codec.html">qstrictutf7codec</option>,  <option value="classQUtf7Codec.html">qutf7codec</option>,  <option value="classRuleEditWidget.html">ruleeditwidget</option>,  <option value="classRuleListWidget.html">rulelistwidget</option>,  <option value="classRuleStack.html">rulestack</option>,  <option value="classScorableGroup.html">scorablegroup</option>,  <option value="classSingleActionWidget.html">singleactionwidget</option>,  <option value="classSingleConditionWidget.html">singleconditionwidget</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../akregator/html/index.html">akregator</a></li><li>&nbsp;&nbsp;<a href="../../akregator/src/html/index.html">src</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li>&nbsp;&nbsp;<a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li>&nbsp;&nbsp;<a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li>&nbsp;&nbsp;<a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li>&nbsp;&nbsp;<a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li>&nbsp;&nbsp;<a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li>&nbsp;&nbsp;<a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>


        </td>
</tr>
</table>

<span class="doNotDisplay">
  <a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
  <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
  <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>


<div style="height: 8px"></div>

<div id="footer">
  <div id="footer_left">
    Maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">Allen Winter</a>.
<br/>
    KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
    <a href="http://www.kde.org/contact/impressum.php">Legal</a>
  </div>
  <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>

<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->

</body>
</html>