EVOLUTION-MANAGER
Edit File: classCPLWorkerThreadPool.html
<!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.5"/> <title>SDTS_AL: CPLWorkerThreadPool 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="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">SDTS_AL </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <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> </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><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classCPLWorkerThreadPool-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">CPLWorkerThreadPool Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="cpl__worker__thread__pool_8h_source.html">cpl_worker_thread_pool.h</a>></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:a132e2ef60c2753e941016aa32575c4fb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLWorkerThreadPool.html#a132e2ef60c2753e941016aa32575c4fb">CPLWorkerThreadPool</a> ()</td></tr> <tr class="separator:a132e2ef60c2753e941016aa32575c4fb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad36dc2afd762ce06b45ba129775ece11"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLWorkerThreadPool.html#ad36dc2afd762ce06b45ba129775ece11">~CPLWorkerThreadPool</a> ()</td></tr> <tr class="separator:ad36dc2afd762ce06b45ba129775ece11"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a257b649dbca8d4cbbc918cd863c63def"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLWorkerThreadPool.html#a257b649dbca8d4cbbc918cd863c63def">Setup</a> (int nThreads, CPLThreadFunc pfnInitFunc, void **pasInitData)</td></tr> <tr class="separator:a257b649dbca8d4cbbc918cd863c63def"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a936c0437b273132083ccd5c405e28e0d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLWorkerThreadPool.html#a936c0437b273132083ccd5c405e28e0d">SubmitJob</a> (CPLThreadFunc pfnFunc, void *pData)</td></tr> <tr class="separator:a936c0437b273132083ccd5c405e28e0d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a53912261cac678125ef5d928c2db5b6c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLWorkerThreadPool.html#a53912261cac678125ef5d928c2db5b6c">SubmitJobs</a> (CPLThreadFunc pfnFunc, const std::vector< void * > &apData)</td></tr> <tr class="separator:a53912261cac678125ef5d928c2db5b6c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af453d0c1cfc14ddf727452dd063ff5ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLWorkerThreadPool.html#af453d0c1cfc14ddf727452dd063ff5ff">WaitCompletion</a> (int nMaxRemainingJobs=0)</td></tr> <tr class="separator:af453d0c1cfc14ddf727452dd063ff5ff"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4cfeeae93d22734d2ce162fdb7b60eb1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPLWorkerThreadPool.html#a4cfeeae93d22734d2ce162fdb7b60eb1">GetThreadCount</a> () const </td></tr> <tr class="separator:a4cfeeae93d22734d2ce162fdb7b60eb1"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Pool of worker threads </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a132e2ef60c2753e941016aa32575c4fb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CPLWorkerThreadPool::CPLWorkerThreadPool </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Instantiate a new pool of worker threads.</p> <p>The pool is in an uninitialized state after this call. The <a class="el" href="classCPLWorkerThreadPool.html#a257b649dbca8d4cbbc918cd863c63def">Setup()</a> method must be called. </p> </div> </div> <a class="anchor" id="ad36dc2afd762ce06b45ba129775ece11"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CPLWorkerThreadPool::~CPLWorkerThreadPool </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destroys a pool of worker threads.</p> <p>Any still pending job will be completed before the destructor returns. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a4cfeeae93d22734d2ce162fdb7b60eb1"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int CPLWorkerThreadPool::GetThreadCount </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return the number of threads setup </p> </div> </div> <a class="anchor" id="a257b649dbca8d4cbbc918cd863c63def"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLWorkerThreadPool::Setup </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>nThreads</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">CPLThreadFunc </td> <td class="paramname"><em>pfnInitFunc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void ** </td> <td class="paramname"><em>pasInitData</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Setup the pool.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nThreads</td><td>Number of threads to launch </td></tr> <tr><td class="paramname">pfnInitFunc</td><td>Initialization function to run in each thread. May be NULL </td></tr> <tr><td class="paramname">pasInitData</td><td>Array of initialization data. Its length must be nThreads, or it should be NULL. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if initialization was successful. </dd></dl> </div> </div> <a class="anchor" id="a936c0437b273132083ccd5c405e28e0d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLWorkerThreadPool::SubmitJob </td> <td>(</td> <td class="paramtype">CPLThreadFunc </td> <td class="paramname"><em>pfnFunc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>pData</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Queue a new job.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pfnFunc</td><td>Function to run for the job. </td></tr> <tr><td class="paramname">pData</td><td>User data to pass to the job function. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true in case of success. </dd></dl> </div> </div> <a class="anchor" id="a53912261cac678125ef5d928c2db5b6c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool CPLWorkerThreadPool::SubmitJobs </td> <td>(</td> <td class="paramtype">CPLThreadFunc </td> <td class="paramname"><em>pfnFunc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::vector< void * > & </td> <td class="paramname"><em>apData</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Queue several jobs</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pfnFunc</td><td>Function to run for the job. </td></tr> <tr><td class="paramname">apData</td><td>User data instances to pass to the job function. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true in case of success. </dd></dl> </div> </div> <a class="anchor" id="af453d0c1cfc14ddf727452dd063ff5ff"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void CPLWorkerThreadPool::WaitCompletion </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>nMaxRemainingJobs</em> = <code>0</code></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Wait for completion of part or whole jobs.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nMaxRemainingJobs</td><td>Maximum number of pendings jobs that are allowed in the queue after this method has completed. Might be 0 to wait for all jobs. </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="cpl__worker__thread__pool_8h_source.html">cpl_worker_thread_pool.h</a></li> <li>cpl_worker_thread_pool.cpp</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.5 </small></address> </body> </html>