<!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: ToolsAppProvider Struct 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">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 class="current"><a href="annotated.html"><span>Data Structures</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>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">ToolsAppProvider Struct Reference<div class="ingroups"><a class="el" href="group__vmtools__plugins.html">VMware Tools Plugins</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="plugin_8h_source.html">plugin.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a1705ec37d9fb3908111a84ce9f118218"><td class="memItemLeft" align="right" valign="top">const gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsAppProvider.html#a1705ec37d9fb3908111a84ce9f118218">name</a></td></tr>
<tr class="separator:a1705ec37d9fb3908111a84ce9f118218"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5cfad9e5531b008b856436fe73aca25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vmtools__plugins.html#gaa58c4987a21e2bdbb4a7a6e28eb861a6">ToolsAppType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsAppProvider.html#af5cfad9e5531b008b856436fe73aca25">regType</a></td></tr>
<tr class="separator:af5cfad9e5531b008b856436fe73aca25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e63899d8e10f1da3c41b9da81d32edc"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsAppProvider.html#a1e63899d8e10f1da3c41b9da81d32edc">regSize</a></td></tr>
<tr class="separator:a1e63899d8e10f1da3c41b9da81d32edc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a381b8ad6428b321aa321e9eb74609f8e"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsAppProvider.html#a381b8ad6428b321aa321e9eb74609f8e">activate</a> )(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, struct <a class="el" href="structToolsAppProvider.html">ToolsAppProvider</a> *prov, GError **err)</td></tr>
<tr class="separator:a381b8ad6428b321aa321e9eb74609f8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d2d4d435e8407094b49262db3e8a19b"><td class="memItemLeft" align="right" valign="top">gboolean(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsAppProvider.html#a5d2d4d435e8407094b49262db3e8a19b">registerApp</a> )(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, struct <a class="el" href="structToolsAppProvider.html">ToolsAppProvider</a> *prov, struct <a class="el" href="structToolsPluginData.html">ToolsPluginData</a> *plugin, gpointer reg)</td></tr>
<tr class="separator:a5d2d4d435e8407094b49262db3e8a19b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cebdc906fad2d376b18b145ab6c8404"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsAppProvider.html#a0cebdc906fad2d376b18b145ab6c8404">shutdown</a> )(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, struct <a class="el" href="structToolsAppProvider.html">ToolsAppProvider</a> *prov)</td></tr>
<tr class="separator:a0cebdc906fad2d376b18b145ab6c8404"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa48561542771f0984434e58d8e01a4e"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsAppProvider.html#afa48561542771f0984434e58d8e01a4e">dumpState</a> )(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, struct <a class="el" href="structToolsAppProvider.html">ToolsAppProvider</a> *prov, gpointer reg)</td></tr>
<tr class="separator:afa48561542771f0984434e58d8e01a4e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Defines the registration data for an "application provider". Application providers allow plugins to hook into new application frameworks that will be then managed by vmtoolsd - for example, an HTTP server or a dbus endpoint.</p>
<p>Application providers will be loaded during startup but not activated until at least one plugin provides registration data for that provider. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a381b8ad6428b321aa321e9eb74609f8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* ToolsAppProvider::activate)(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, struct <a class="el" href="structToolsAppProvider.html">ToolsAppProvider</a> *prov, GError **err)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Activation callback (optional). This is called when vmtoolsd detects that there is at least one application that needs to be registered with this provider.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>The application context. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prov</td><td>The provider instance. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">err</td><td>Where to store any error information. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afa48561542771f0984434e58d8e01a4e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* ToolsAppProvider::dumpState)(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, struct <a class="el" href="structToolsAppProvider.html">ToolsAppProvider</a> *prov, gpointer reg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Debugging callback (optional). This callback is called when dumping the service state to the logs for debugging purposes.</p>
<p>This callback is called once with a "NULL" reg, so that the provider can log its internal state, and then once for each registration struct provided by loaded plugins.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>The application context. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prov</td><td>The provider instance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>The application registration data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1705ec37d9fb3908111a84ce9f118218"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const gchar* ToolsAppProvider::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>A name describing the provider. </p>
</div>
</div>
<a class="anchor" id="a5d2d4d435e8407094b49262db3e8a19b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean(* ToolsAppProvider::registerApp)(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, struct <a class="el" href="structToolsAppProvider.html">ToolsAppProvider</a> *prov, struct <a class="el" href="structToolsPluginData.html">ToolsPluginData</a> *plugin, gpointer reg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Registration callback. This is called after "activate", to register an application provided by a plugin.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>The application context. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prov</td><td>The provider instance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">plugin</td><td>The plugin that owns the registration. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>The application registration data.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether registration succeeded. </dd></dl>
</div>
</div>
<a class="anchor" id="a1e63899d8e10f1da3c41b9da81d32edc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ToolsAppProvider::regSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the registration structure for this provider. </p>
</div>
</div>
<a class="anchor" id="af5cfad9e5531b008b856436fe73aca25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__vmtools__plugins.html#gaa58c4987a21e2bdbb4a7a6e28eb861a6">ToolsAppType</a> ToolsAppProvider::regType</td>
</tr>
</table>
</div><div class="memdoc">
<p>Application type. Optimally, new providers would request a new type to be added to the "official" ToolsAppType enum declared above, although that is not strictly necessary. Providers should at least try to choose an unused value. </p>
</div>
</div>
<a class="anchor" id="a0cebdc906fad2d376b18b145ab6c8404"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* ToolsAppProvider::shutdown)(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, struct <a class="el" href="structToolsAppProvider.html">ToolsAppProvider</a> *prov)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shutdown callback (optional). Called when the service is being shut down. The provider is responsible for keeping track of registrations and cleaning them up during shutdown.</p>
<p>This method is only called if the provider was successfully activated.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>The application context. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prov</td><td>The provider instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>lib/include/vmware/tools/<a class="el" href="plugin_8h_source.html">plugin.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 13 2013 17:04:41 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>
