<!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>Apache log4cxx: Thread Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1helpers_1_1_thread.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>Thread Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::Thread" -->
<p>This class implements an approximation of java.util.Thread.
<a href="#_details">More...</a></p>
<p><a href="classlog4cxx_1_1helpers_1_1_thread-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><b>LaunchPackage</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class is used to encapsulate the parameters to <a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#a0189281d271b6817d82fc64fb3db2435" title="Runs the specified method on a newly created thread.">Thread::run</a> when they are passed to Thread::launcher. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><b>LaunchStatus</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This object atomically sets the specified memory location to non-zero on construction and to zero on destruction. <br/></td></tr>
<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="classlog4cxx_1_1helpers_1_1_thread.html#a7542b81caf3dbfcbd2b2f217fd10c240">Thread</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new instance. <a href="#a7542b81caf3dbfcbd2b2f217fd10c240"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#a87a9c69a69ee4b13cb1ec5772f6d32ad">~Thread</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a87a9c69a69ee4b13cb1ec5772f6d32ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#a0189281d271b6817d82fc64fb3db2435">run</a> (<a class="el" href="namespacelog4cxx_1_1helpers.html#adf12756fe75e2e30213142c835c7f027">Runnable</a> start, void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runs the specified method on a newly created thread. <a href="#a0189281d271b6817d82fc64fb3db2435"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#a6c7abfff648dad193674fc432ad4840d">join</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#aa1f512ab0fcc05612f8e3d6a4664ce9a">isActive</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#aebc9afd317d656680550a13818e71917">interrupt</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupted status to true. <a href="#aebc9afd317d656680550a13818e71917"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#a59db7399f5931387fa42b8685cbc137c">isAlive</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#ac0fe129374c32587cb88df488197c755">isCurrentThread</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#a893d1bcb960a17b354855c3bd338c298">ending</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
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="classlog4cxx_1_1helpers_1_1_thread.html#acf7fcd52c361b38b008c5f769c43952a">sleep</a> (int millis)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Causes the currently executing thread to sleep for the specified number of milliseconds. <a href="#acf7fcd52c361b38b008c5f769c43952a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#a4a64fd9bbc9ecd8fe45bd2a788d7c9d3">currentThreadInterrupt</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupted status for current thread to true. <a href="#a4a64fd9bbc9ecd8fe45bd2a788d7c9d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html#a31eaaefa21bd7b6f71fcc40fb3083604">interrupted</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tests if the current thread has been interrupted and sets the interrupted status to false. <a href="#a31eaaefa21bd7b6f71fcc40fb3083604"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class implements an approximation of java.util.Thread. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7542b81caf3dbfcbd2b2f217fd10c240"></a><!-- doxytag: member="log4cxx::helpers::Thread::Thread" ref="a7542b81caf3dbfcbd2b2f217fd10c240" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html">Thread</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create new instance. </p>
</div>
</div>
<a class="anchor" id="a87a9c69a69ee4b13cb1ec5772f6d32ad"></a><!-- doxytag: member="log4cxx::helpers::Thread::~Thread" ref="a87a9c69a69ee4b13cb1ec5772f6d32ad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html">Thread</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4a64fd9bbc9ecd8fe45bd2a788d7c9d3"></a><!-- doxytag: member="log4cxx::helpers::Thread::currentThreadInterrupt" ref="a4a64fd9bbc9ecd8fe45bd2a788d7c9d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void currentThreadInterrupt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets interrupted status for current thread to true. </p>
</div>
</div>
<a class="anchor" id="a893d1bcb960a17b354855c3bd338c298"></a><!-- doxytag: member="log4cxx::helpers::Thread::ending" ref="a893d1bcb960a17b354855c3bd338c298" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ending </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aebc9afd317d656680550a13818e71917"></a><!-- doxytag: member="log4cxx::helpers::Thread::interrupt" ref="aebc9afd317d656680550a13818e71917" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void interrupt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets interrupted status to true. </p>
</div>
</div>
<a class="anchor" id="a31eaaefa21bd7b6f71fcc40fb3083604"></a><!-- doxytag: member="log4cxx::helpers::Thread::interrupted" ref="a31eaaefa21bd7b6f71fcc40fb3083604" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool interrupted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tests if the current thread has been interrupted and sets the interrupted status to false. </p>
</div>
</div>
<a class="anchor" id="aa1f512ab0fcc05612f8e3d6a4664ce9a"></a><!-- doxytag: member="log4cxx::helpers::Thread::isActive" ref="aa1f512ab0fcc05612f8e3d6a4664ce9a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isActive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a59db7399f5931387fa42b8685cbc137c"></a><!-- doxytag: member="log4cxx::helpers::Thread::isAlive" ref="a59db7399f5931387fa42b8685cbc137c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isAlive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac0fe129374c32587cb88df488197c755"></a><!-- doxytag: member="log4cxx::helpers::Thread::isCurrentThread" ref="ac0fe129374c32587cb88df488197c755" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isCurrentThread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6c7abfff648dad193674fc432ad4840d"></a><!-- doxytag: member="log4cxx::helpers::Thread::join" ref="a6c7abfff648dad193674fc432ad4840d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void join </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0189281d271b6817d82fc64fb3db2435"></a><!-- doxytag: member="log4cxx::helpers::Thread::run" ref="a0189281d271b6817d82fc64fb3db2435" args="(Runnable start, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelog4cxx_1_1helpers.html#adf12756fe75e2e30213142c835c7f027">Runnable</a> </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Runs the specified method on a newly created thread. </p>
</div>
</div>
<a class="anchor" id="acf7fcd52c361b38b008c5f769c43952a"></a><!-- doxytag: member="log4cxx::helpers::Thread::sleep" ref="acf7fcd52c361b38b008c5f769c43952a" args="(int millis)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void sleep </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>millis</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Causes the currently executing thread to sleep for the specified number of milliseconds. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">millis</td><td>milliseconds. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">Interrupted</td><td><a class="el" href="classlog4cxx_1_1helpers_1_1_exception.html" title="The class Exception and its subclasses indicate conditions that a reasonable application might want t...">Exception</a> if the thread is interrupted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thread_8h.html">thread.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1helpers.html">helpers</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1helpers_1_1_thread.html">Thread</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
