<!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.11"/>
<title>Transient Recorder Framework: TRWorkerThread 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Transient Recorder Framework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classTRWorkerThread-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TRWorkerThread Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A simple worker thread with a queue of tasks.
<a href="classTRWorkerThread.html#details">More...</a></p>
<p><code>#include <<a class="el" href="TRWorkerThread_8h_source.html">TRWorkerThread.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TRWorkerThread:</div>
<div class="dyncontent">
<div class="center">
<img src="classTRWorkerThread.png" usemap="#TRWorkerThread_map" alt=""/>
<map id="TRWorkerThread_map" name="TRWorkerThread_map">
</map>
</div></div>
<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:adf073ea403852e9e0879855c540c193c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTRWorkerThread.html#adf073ea403852e9e0879855c540c193c">TRWorkerThread</a> (std::string const &thread_name)</td></tr>
<tr class="memdesc:adf073ea403852e9e0879855c540c193c"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the worker thread. <a href="#adf073ea403852e9e0879855c540c193c">More...</a><br /></td></tr>
<tr class="separator:adf073ea403852e9e0879855c540c193c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31be3b8364976813f163d11a4ab69753"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTRWorkerThread.html#a31be3b8364976813f163d11a4ab69753">~TRWorkerThread</a> ()</td></tr>
<tr class="memdesc:a31be3b8364976813f163d11a4ab69753"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the worker thread. <a href="#a31be3b8364976813f163d11a4ab69753">More...</a><br /></td></tr>
<tr class="separator:a31be3b8364976813f163d11a4ab69753"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2fc8126f786bab8115a1f2453078815a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTRWorkerThread.html#a2fc8126f786bab8115a1f2453078815a">start</a> ()</td></tr>
<tr class="memdesc:a2fc8126f786bab8115a1f2453078815a"><td class="mdescLeft"> </td><td class="mdescRight">Start the worker thread. <a href="#a2fc8126f786bab8115a1f2453078815a">More...</a><br /></td></tr>
<tr class="separator:a2fc8126f786bab8115a1f2453078815a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af476f4ddddb1fc9d75026b0fa917bdde"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af476f4ddddb1fc9d75026b0fa917bdde"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTRWorkerThread.html#af476f4ddddb1fc9d75026b0fa917bdde">stop</a> ()</td></tr>
<tr class="memdesc:af476f4ddddb1fc9d75026b0fa917bdde"><td class="mdescLeft"> </td><td class="mdescRight">Send a signal to the worker thread and wait for it stop. <br /></td></tr>
<tr class="separator:af476f4ddddb1fc9d75026b0fa917bdde"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a5a971e17d351a7abf3a66c25cc4b9fac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a971e17d351a7abf3a66c25cc4b9fac"></a>
class </td><td class="memItemRight" valign="bottom"><b>TRWorkerThreadTask</b></td></tr>
<tr class="separator:a5a971e17d351a7abf3a66c25cc4b9fac"><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 simple worker thread with a queue of tasks. </p>
<p>Implements a worker thread to which arbitrary tasks can be queued for execution. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="adf073ea403852e9e0879855c540c193c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TRWorkerThread::TRWorkerThread </td>
<td>(</td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>thread_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the worker thread. </p>
<p>After construction, start should be called to start operation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">thread_name</td><td>The name for the thread. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a31be3b8364976813f163d11a4ab69753"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TRWorkerThread::~TRWorkerThread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor for the worker thread. </p>
<p>It does <a class="el" href="classTRWorkerThread.html#af476f4ddddb1fc9d75026b0fa917bdde" title="Send a signal to the worker thread and wait for it stop. ">stop()</a>, nevertheless it is a good idea to call <a class="el" href="classTRWorkerThread.html#af476f4ddddb1fc9d75026b0fa917bdde" title="Send a signal to the worker thread and wait for it stop. ">stop()</a> explicitly before destruction, due to possible issues with virtual functions. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2fc8126f786bab8115a1f2453078815a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TRWorkerThread::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the worker thread. </p>
<p>This should be called once after construction and must not be called again. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="TRWorkerThread_8h_source.html">TRWorkerThread.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>