<!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"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>xmltooling: xmltooling::Thread Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">xmltooling
 <span id="projectnumber">1.5.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00087.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="a00296.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xmltooling::Thread Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A class for manual thread creation and synchronization.
<a href="a00087.html#details">More...</a></p>
<p><code>#include <xmltooling/util/Threads.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad06549ae5c7ce80597a5530479dcb99c"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#ad06549ae5c7ce80597a5530479dcb99c">detach</a> ()=0</td></tr>
<tr class="memdesc:ad06549ae5c7ce80597a5530479dcb99c"><td class="mdescLeft"> </td><td class="mdescRight">Disassociate from the thread. <a href="#ad06549ae5c7ce80597a5530479dcb99c">More...</a><br /></td></tr>
<tr class="separator:ad06549ae5c7ce80597a5530479dcb99c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5ef9a8463d9e43b406022f6c1b8d199"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#ae5ef9a8463d9e43b406022f6c1b8d199">join</a> (void **thread_return)=0</td></tr>
<tr class="memdesc:ae5ef9a8463d9e43b406022f6c1b8d199"><td class="mdescLeft"> </td><td class="mdescRight">Join with the thread and wait for its completion. <a href="#ae5ef9a8463d9e43b406022f6c1b8d199">More...</a><br /></td></tr>
<tr class="separator:ae5ef9a8463d9e43b406022f6c1b8d199"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a834ffac4c81ed19878efe01509ea6e45"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#a834ffac4c81ed19878efe01509ea6e45">kill</a> (int signo)=0</td></tr>
<tr class="memdesc:a834ffac4c81ed19878efe01509ea6e45"><td class="mdescLeft"> </td><td class="mdescRight">Kill the thread. <a href="#a834ffac4c81ed19878efe01509ea6e45">More...</a><br /></td></tr>
<tr class="separator:a834ffac4c81ed19878efe01509ea6e45"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a2cc7c1ad36a965f7d767b7b3a36a0b89"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00087.html">Thread</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#a2cc7c1ad36a965f7d767b7b3a36a0b89">create</a> (void *(*start_routine)(void *), void *arg, size_t stacksize=0)</td></tr>
<tr class="memdesc:a2cc7c1ad36a965f7d767b7b3a36a0b89"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new thread object to run the supplied start routine. <a href="#a2cc7c1ad36a965f7d767b7b3a36a0b89">More...</a><br /></td></tr>
<tr class="separator:a2cc7c1ad36a965f7d767b7b3a36a0b89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17e1d8a1abe662f6cb538912d06cdbc1"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#a17e1d8a1abe662f6cb538912d06cdbc1">exit</a> (void *return_val)</td></tr>
<tr class="memdesc:a17e1d8a1abe662f6cb538912d06cdbc1"><td class="mdescLeft"> </td><td class="mdescRight">Exits a thread gracefully. <a href="#a17e1d8a1abe662f6cb538912d06cdbc1">More...</a><br /></td></tr>
<tr class="separator:a17e1d8a1abe662f6cb538912d06cdbc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af962224e99122fb0635f59f9d93f5530"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#af962224e99122fb0635f59f9d93f5530">sleep</a> (int seconds)</td></tr>
<tr class="memdesc:af962224e99122fb0635f59f9d93f5530"><td class="mdescLeft"> </td><td class="mdescRight">Sleeps the current thread for the specified amount of time. <a href="#af962224e99122fb0635f59f9d93f5530">More...</a><br /></td></tr>
<tr class="separator:af962224e99122fb0635f59f9d93f5530"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedec822b2be29be467bec8465bcc0a1d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedec822b2be29be467bec8465bcc0a1d"></a>
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#aedec822b2be29be467bec8465bcc0a1d">mask_all_signals</a> (void)</td></tr>
<tr class="memdesc:aedec822b2be29be467bec8465bcc0a1d"><td class="mdescLeft"> </td><td class="mdescRight">Masks all signals from a thread. <br /></td></tr>
<tr class="separator:aedec822b2be29be467bec8465bcc0a1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1430ea421efa18edafd379a0585bf948"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00087.html#a1430ea421efa18edafd379a0585bf948">mask_signals</a> (int how, const sigset_t *newmask, sigset_t *oldmask)</td></tr>
<tr class="memdesc:a1430ea421efa18edafd379a0585bf948"><td class="mdescLeft"> </td><td class="mdescRight">Masks specific signals from a thread. <a href="#a1430ea421efa18edafd379a0585bf948">More...</a><br /></td></tr>
<tr class="separator:a1430ea421efa18edafd379a0585bf948"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class for manual thread creation and synchronization. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2cc7c1ad36a965f7d767b7b3a36a0b89"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00087.html">Thread</a>* xmltooling::Thread::create </td>
<td>(</td>
<td class="paramtype">void *(*)(void *) </td>
<td class="paramname"><em>start_routine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>stacksize</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new thread object to run the supplied start routine. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start_routine</td><td>the function to execute on the thread </td></tr>
<tr><td class="paramname">arg</td><td>a parameter for the start routine </td></tr>
<tr><td class="paramname">stacksize</td><td>size of stack to use, or 0 for default </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the created and running thread object </dd></dl>
</div>
</div>
<a class="anchor" id="ad06549ae5c7ce80597a5530479dcb99c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int xmltooling::Thread::detach </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Disassociate from the thread. </p>
<dl class="section return"><dt>Returns</dt><dd>0 for success, non-zero for failure </dd></dl>
</div>
</div>
<a class="anchor" id="a17e1d8a1abe662f6cb538912d06cdbc1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void xmltooling::Thread::exit </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>return_val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Exits a thread gracefully. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">return_val</td><td>the return value for the thread </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae5ef9a8463d9e43b406022f6c1b8d199"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int xmltooling::Thread::join </td>
<td>(</td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>thread_return</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Join with the thread and wait for its completion. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">thread_return</td><td>holds the return value of the thread routine </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for success, non-zero for failure </dd></dl>
</div>
</div>
<a class="anchor" id="a834ffac4c81ed19878efe01509ea6e45"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int xmltooling::Thread::kill </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>signo</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Kill the thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signo</td><td>the signal to send to the thread </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for success, non-zero for failure </dd></dl>
</div>
</div>
<a class="anchor" id="a1430ea421efa18edafd379a0585bf948"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int xmltooling::Thread::mask_signals </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>how</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const sigset_t * </td>
<td class="paramname"><em>newmask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">sigset_t * </td>
<td class="paramname"><em>oldmask</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Masks specific signals from a thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">how</td><td></td></tr>
<tr><td class="paramname">newmask</td><td>the new signal mask </td></tr>
<tr><td class="paramname">oldmask</td><td>the old signal mask </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for success, non-zero for failure </dd></dl>
</div>
</div>
<a class="anchor" id="af962224e99122fb0635f59f9d93f5530"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void xmltooling::Thread::sleep </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>seconds</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sleeps the current thread for the specified amount of time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seconds</td><td>time to sleep </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xmltooling/util/<a class="el" href="a00190.html">Threads.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00087.html">Thread</a></li>
<li class="footer">Generated on Fri Oct 17 2014 12:44:58 for xmltooling by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
553d1e1391b9f1acad517c925f34ae45
>
files
>
324
