<!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>open-vm-tools 9.4.0: lib/include/vmware/tools/threadPool.h Source File</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">open-vm-tools 9.4.0
</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="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_5a30104352ef4255dc24354b02eb2d20.html">include</a></li><li class="navelem"><a class="el" href="dir_1ae46aceb4fd0d0c4a241d08c8eb4ed3.html">vmware</a></li><li class="navelem"><a class="el" href="dir_93b95978f0d6069d74a14c562abea915.html">tools</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">threadPool.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="threadPool_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*********************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2010 VMware, Inc. All rights reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This program is free software; you can redistribute it and/or modify it</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * under the terms of the GNU Lesser General Public License as published</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * by the Free Software Foundation version 2.1 and no later version.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * This program is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU General Public</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * License for more details.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * along with this program; if not, write to the Free Software Foundation, Inc.,</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> *********************************************************/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef _THREADPOOL_H_</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"></span><span class="preprocessor">#define _THREADPOOL_H_</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include <glib-object.h></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#include "<a class="code" href="plugin_8h.html">vmware/tools/plugin.h</a>"</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define TOOLS_CORE_PROP_TPOOL "tcs_prop_thread_pool"</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef"> 54</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef">ToolsCorePoolCb</a>)(<a class="code" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  gpointer data);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structToolsCorePool.html"> 66</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structToolsCorePool.html">ToolsCorePool</a> {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  guint (*submit)(<a class="code" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef">ToolsCorePoolCb</a> cb,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  gpointer data,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  GDestroyNotify dtor);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  void (*cancel)(guint id);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  gboolean (*start)(<a class="code" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef">ToolsCorePoolCb</a> cb,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef">ToolsCorePoolCb</a> interrupt,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  gpointer data,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  GDestroyNotify dtor);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> } <a class="code" href="group__vmtools__threads.html#gaaaa983561dc51500105b231613fe63d9">ToolsCorePool</a>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> *******************************************************************************</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * ToolsCorePool_GetPool -- */</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> G_INLINE_FUNC <a class="code" href="structToolsCorePool.html">ToolsCorePool</a> *</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="group__vmtools__threads.html#gac715e0f8fd6527c369c634873000d23b"> 94</a></span> <a class="code" href="group__vmtools__threads.html#gac715e0f8fd6527c369c634873000d23b">ToolsCorePool_GetPool</a>(<a class="code" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx)</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> {</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="structToolsCorePool.html">ToolsCorePool</a> *pool = NULL;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  g_object_get(ctx-><a class="code" href="structToolsAppCtx.html#a88fa545c7fdc5415d1638eef49f306d9">serviceObj</a>, TOOLS_CORE_PROP_TPOOL, &pool, NULL);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">return</span> pool;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> }</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> *******************************************************************************</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * ToolsCorePool_SubmitTask -- */</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> G_INLINE_FUNC guint</div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="group__vmtools__threads.html#ga813481657b59433baed593d8a7ff62e7"> 126</a></span> <a class="code" href="group__vmtools__threads.html#ga813481657b59433baed593d8a7ff62e7">ToolsCorePool_SubmitTask</a>(<a class="code" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx,</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <a class="code" href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef">ToolsCorePoolCb</a> cb,</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  gpointer data,</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  GDestroyNotify dtor)</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> {</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="structToolsCorePool.html">ToolsCorePool</a> *pool = <a class="code" href="group__vmtools__threads.html#gac715e0f8fd6527c369c634873000d23b">ToolsCorePool_GetPool</a>(ctx);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">if</span> (pool != NULL) {</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">return</span> pool->submit(ctx, cb, data, dtor);</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> }</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> *******************************************************************************</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * ToolsCorePool_CancelTask -- */</span> </div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> G_INLINE_FUNC <span class="keywordtype">void</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="group__vmtools__threads.html#ga947496fbfc2cf6a1e8afd24d125c18bc"> 156</a></span> <a class="code" href="group__vmtools__threads.html#ga947496fbfc2cf6a1e8afd24d125c18bc">ToolsCorePool_CancelTask</a>(<a class="code" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx,</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  guint taskId)</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> {</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="structToolsCorePool.html">ToolsCorePool</a> *pool = <a class="code" href="group__vmtools__threads.html#gac715e0f8fd6527c369c634873000d23b">ToolsCorePool_GetPool</a>(ctx);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordflow">if</span> (pool != NULL) {</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  pool->cancel(taskId);</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  }</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> }</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> *******************************************************************************</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * ToolsCorePool_StartThread -- */</span> </div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> G_INLINE_FUNC gboolean</div>
<div class="line"><a name="l00199"></a><span class="lineno"><a class="line" href="group__vmtools__threads.html#ga7f78bcaad21c82ddb8df50384564ddb0"> 199</a></span> <a class="code" href="group__vmtools__threads.html#ga7f78bcaad21c82ddb8df50384564ddb0">ToolsCorePool_StartThread</a>(<a class="code" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx,</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <a class="code" href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef">ToolsCorePoolCb</a> cb,</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <a class="code" href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef">ToolsCorePoolCb</a> interrupt,</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  gpointer data,</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  GDestroyNotify dtor)</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> {</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <a class="code" href="structToolsCorePool.html">ToolsCorePool</a> *pool = <a class="code" href="group__vmtools__threads.html#gac715e0f8fd6527c369c634873000d23b">ToolsCorePool_GetPool</a>(ctx);</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordflow">if</span> (pool != NULL) {</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordflow">return</span> pool->start(ctx, cb, interrupt, data, dtor);</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  }</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> }</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="preprocessor">#endif </span><span class="comment">/* _THREADPOOL_H_ */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="preprocessor"></span></div>
<div class="ttc" id="group__vmtools__threads_html_gac715e0f8fd6527c369c634873000d23b"><div class="ttname"><a href="group__vmtools__threads.html#gac715e0f8fd6527c369c634873000d23b">ToolsCorePool_GetPool</a></div><div class="ttdeci">G_INLINE_FUNC ToolsCorePool * ToolsCorePool_GetPool(ToolsAppCtx *ctx)</div><div class="ttdoc">Returns the thread pool instance for the service. </div><div class="ttdef"><b>Definition:</b> threadPool.h:94</div></div>
<div class="ttc" id="group__vmtools__threads_html_ga947496fbfc2cf6a1e8afd24d125c18bc"><div class="ttname"><a href="group__vmtools__threads.html#ga947496fbfc2cf6a1e8afd24d125c18bc">ToolsCorePool_CancelTask</a></div><div class="ttdeci">G_INLINE_FUNC void ToolsCorePool_CancelTask(ToolsAppCtx *ctx, guint taskId)</div><div class="ttdoc">Cancels a task previously submitted to the pool. </div><div class="ttdef"><b>Definition:</b> threadPool.h:156</div></div>
<div class="ttc" id="plugin_8h_html"><div class="ttname"><a href="plugin_8h.html">plugin.h</a></div></div>
<div class="ttc" id="group__vmtools__threads_html_gaaaa983561dc51500105b231613fe63d9"><div class="ttname"><a href="group__vmtools__threads.html#gaaaa983561dc51500105b231613fe63d9">ToolsCorePool</a></div><div class="ttdeci">struct ToolsCorePool ToolsCorePool</div><div class="ttdoc">Public interface of the shared thread pool. </div></div>
<div class="ttc" id="group__vmtools__threads_html_ga7f78bcaad21c82ddb8df50384564ddb0"><div class="ttname"><a href="group__vmtools__threads.html#ga7f78bcaad21c82ddb8df50384564ddb0">ToolsCorePool_StartThread</a></div><div class="ttdeci">G_INLINE_FUNC gboolean ToolsCorePool_StartThread(ToolsAppCtx *ctx, ToolsCorePoolCb cb, ToolsCorePoolCb interrupt, gpointer data, GDestroyNotify dtor)</div><div class="ttdoc">Starts a task on its own thread. </div><div class="ttdef"><b>Definition:</b> threadPool.h:199</div></div>
<div class="ttc" id="structToolsAppCtx_html_a88fa545c7fdc5415d1638eef49f306d9"><div class="ttname"><a href="structToolsAppCtx.html#a88fa545c7fdc5415d1638eef49f306d9">ToolsAppCtx::serviceObj</a></div><div class="ttdeci">gpointer serviceObj</div><div class="ttdef"><b>Definition:</b> plugin.h:257</div></div>
<div class="ttc" id="structToolsCorePool_html"><div class="ttname"><a href="structToolsCorePool.html">ToolsCorePool</a></div><div class="ttdoc">Public interface of the shared thread pool. </div><div class="ttdef"><b>Definition:</b> threadPool.h:66</div></div>
<div class="ttc" id="group__vmtools__threads_html_ga0896f3dc59232c168a431e835e7229ef"><div class="ttname"><a href="group__vmtools__threads.html#ga0896f3dc59232c168a431e835e7229ef">ToolsCorePoolCb</a></div><div class="ttdeci">void(* ToolsCorePoolCb)(ToolsAppCtx *ctx, gpointer data)</div><div class="ttdef"><b>Definition:</b> threadPool.h:54</div></div>
<div class="ttc" id="structToolsAppCtx_html"><div class="ttname"><a href="structToolsAppCtx.html">ToolsAppCtx</a></div><div class="ttdef"><b>Definition:</b> plugin.h:227</div></div>
<div class="ttc" id="group__vmtools__threads_html_ga813481657b59433baed593d8a7ff62e7"><div class="ttname"><a href="group__vmtools__threads.html#ga813481657b59433baed593d8a7ff62e7">ToolsCorePool_SubmitTask</a></div><div class="ttdeci">G_INLINE_FUNC guint ToolsCorePool_SubmitTask(ToolsAppCtx *ctx, ToolsCorePoolCb cb, gpointer data, GDestroyNotify dtor)</div><div class="ttdoc">Submits a task for execution in the thread pool. </div><div class="ttdef"><b>Definition:</b> threadPool.h:126</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 13 2013 17:04:40 for open-vm-tools 9.4.0 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>
