<!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/guestrpc.h File 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><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="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">guestrpc.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <glib.h></code><br/>
<code>#include "<a class="el" href="utils_8h_source.html">vmware/tools/utils.h</a>"</code><br/>
</div>
<p><a href="guestrpc_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRpcInData.html">RpcInData</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRpcChannelCallback.html">RpcChannelCallback</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structRpcChannel.html">RpcChannel</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga2a93456666122054075ed3592e84d5c9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga2a93456666122054075ed3592e84d5c9">RPCIN_SETRETVALS</a>   RpcChannel_SetRetVals</td></tr>
<tr class="separator:ga2a93456666122054075ed3592e84d5c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6fa5b67b1250ce43e0834073377dfeb9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6fa5b67b1250ce43e0834073377dfeb9"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RPCIN_SETRETVALSF</b>   RpcChannel_SetRetValsF</td></tr>
<tr class="separator:ga6fa5b67b1250ce43e0834073377dfeb9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga04b733f572652ac0da61168071539775"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structRpcInData.html">RpcInData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga04b733f572652ac0da61168071539775">RpcInData</a></td></tr>
<tr class="separator:ga04b733f572652ac0da61168071539775"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4d660f7c6afeb9ad7c447e8e16ca3a58"><td class="memItemLeft" align="right" valign="top">typedef gboolean(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga4d660f7c6afeb9ad7c447e8e16ca3a58">RpcIn_Callback</a> )(<a class="el" href="structRpcInData.html">RpcInData</a> *data)</td></tr>
<tr class="separator:ga4d660f7c6afeb9ad7c447e8e16ca3a58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7955597e5a709c6aa19eac8b97a9fa42"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structRpcChannelCallback.html">RpcChannelCallback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga7955597e5a709c6aa19eac8b97a9fa42">RpcChannelCallback</a></td></tr>
<tr class="separator:ga7955597e5a709c6aa19eac8b97a9fa42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8801793b9d14f7bde32566e50b831d52"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8801793b9d14f7bde32566e50b831d52"></a>
typedef gboolean(* </td><td class="memItemRight" valign="bottom"><b>RpcChannelStartFn</b> )(struct <a class="el" href="structRpcChannel.html">RpcChannel</a> *)</td></tr>
<tr class="separator:ga8801793b9d14f7bde32566e50b831d52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf6800d4a84c156742a11d0037bbc272f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf6800d4a84c156742a11d0037bbc272f"></a>
typedef void(* </td><td class="memItemRight" valign="bottom"><b>RpcChannelStopFn</b> )(struct <a class="el" href="structRpcChannel.html">RpcChannel</a> *)</td></tr>
<tr class="separator:gaf6800d4a84c156742a11d0037bbc272f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab49e7ee6e99c2efe65489602da00a7b8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab49e7ee6e99c2efe65489602da00a7b8"></a>
typedef void(* </td><td class="memItemRight" valign="bottom"><b>RpcChannelShutdownFn</b> )(struct <a class="el" href="structRpcChannel.html">RpcChannel</a> *)</td></tr>
<tr class="separator:gab49e7ee6e99c2efe65489602da00a7b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga06b0db0dd5e82872d08c2d5d22daac08"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga06b0db0dd5e82872d08c2d5d22daac08"></a>
typedef gboolean(* </td><td class="memItemRight" valign="bottom"><b>RpcChannelSendFn</b> )(struct <a class="el" href="structRpcChannel.html">RpcChannel</a> *, char const *data, size_t dataLen, char **result, size_t *resultLen)</td></tr>
<tr class="separator:ga06b0db0dd5e82872d08c2d5d22daac08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91fc1898ed731895afb408b27a047f00"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga91fc1898ed731895afb408b27a047f00"></a>
typedef void(* </td><td class="memItemRight" valign="bottom"><b>RpcChannelSetupFn</b> )(struct <a class="el" href="structRpcChannel.html">RpcChannel</a> *chan, GMainContext *mainCtx, const char *appName, gpointer appCtx)</td></tr>
<tr class="separator:ga91fc1898ed731895afb408b27a047f00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d8df0661714ae39aa03d2e45ab9b9cb"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga8d8df0661714ae39aa03d2e45ab9b9cb">RpcChannelResetCb</a> )(struct <a class="el" href="structRpcChannel.html">RpcChannel</a> *chan, gboolean success, gpointer data)</td></tr>
<tr class="separator:ga8d8df0661714ae39aa03d2e45ab9b9cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5dd4ab84b18cc68fa6d4d0cfb3cc08bd"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structRpcChannel.html">RpcChannel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga5dd4ab84b18cc68fa6d4d0cfb3cc08bd">RpcChannel</a></td></tr>
<tr class="separator:ga5dd4ab84b18cc68fa6d4d0cfb3cc08bd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga9e23f202e822dd6eec004e30b4ca3a24"><td class="memItemLeft" align="right" valign="top">G_INLINE_FUNC gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga9e23f202e822dd6eec004e30b4ca3a24">RpcChannel_Start</a> (<a class="el" href="structRpcChannel.html">RpcChannel</a> *chan)</td></tr>
<tr class="separator:ga9e23f202e822dd6eec004e30b4ca3a24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4f5ef621d6e034c7bfc4181a87b17ce7"><td class="memItemLeft" align="right" valign="top">G_INLINE_FUNC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga4f5ef621d6e034c7bfc4181a87b17ce7">RpcChannel_Stop</a> (<a class="el" href="structRpcChannel.html">RpcChannel</a> *chan)</td></tr>
<tr class="separator:ga4f5ef621d6e034c7bfc4181a87b17ce7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaef78bc4364e5150e6176f3e5772fa988"><td class="memItemLeft" align="right" valign="top">G_INLINE_FUNC gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#gaef78bc4364e5150e6176f3e5772fa988">RpcChannel_Send</a> (<a class="el" href="structRpcChannel.html">RpcChannel</a> *chan, char const *data, size_t dataLen, char **result, size_t *resultLen)</td></tr>
<tr class="separator:gaef78bc4364e5150e6176f3e5772fa988"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa51fcf3f9e8c8ca0d880c259f2cf6918"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa51fcf3f9e8c8ca0d880c259f2cf6918"></a>
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_BuildXdrCommand</b> (const char *cmd, void *xdrProc, void *xdrData, char **result, size_t *resultLen)</td></tr>
<tr class="separator:gaa51fcf3f9e8c8ca0d880c259f2cf6918"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1393b131648b8f62489a342dd26d3290"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1393b131648b8f62489a342dd26d3290"></a>
<a class="el" href="structRpcChannel.html">RpcChannel</a> * </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Create</b> (void)</td></tr>
<tr class="separator:ga1393b131648b8f62489a342dd26d3290"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga54aa7166d2accef8e107601fa0f957ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga54aa7166d2accef8e107601fa0f957ae"></a>
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Destroy</b> (<a class="el" href="structRpcChannel.html">RpcChannel</a> *chan)</td></tr>
<tr class="separator:ga54aa7166d2accef8e107601fa0f957ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6de720c1598cf7c4605bf00bccd8bfdd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6de720c1598cf7c4605bf00bccd8bfdd"></a>
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Dispatch</b> (<a class="el" href="structRpcInData.html">RpcInData</a> *data)</td></tr>
<tr class="separator:ga6de720c1598cf7c4605bf00bccd8bfdd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga86fb202721dc1d59a4ea58e969423aef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga86fb202721dc1d59a4ea58e969423aef"></a>
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Setup</b> (<a class="el" href="structRpcChannel.html">RpcChannel</a> *chan, const gchar *appName, GMainContext *mainCtx, gpointer appCtx, <a class="el" href="group__vmtools__guestrpc.html#ga8d8df0661714ae39aa03d2e45ab9b9cb">RpcChannelResetCb</a> resetCb, gpointer resetData)</td></tr>
<tr class="separator:ga86fb202721dc1d59a4ea58e969423aef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaff05ab8e38ff71780ffc51b9a259bc2c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaff05ab8e38ff71780ffc51b9a259bc2c"></a>
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_RegisterCallback</b> (<a class="el" href="structRpcChannel.html">RpcChannel</a> *chan, <a class="el" href="structRpcChannelCallback.html">RpcChannelCallback</a> *rpc)</td></tr>
<tr class="separator:gaff05ab8e38ff71780ffc51b9a259bc2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64c45e713f72a65ad7e378c397fb37c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga64c45e713f72a65ad7e378c397fb37c8"></a>
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_SetRetVals</b> (<a class="el" href="structRpcInData.html">RpcInData</a> *data, char const *result, gboolean retVal)</td></tr>
<tr class="separator:ga64c45e713f72a65ad7e378c397fb37c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3cf527f6e0b2cbb70daa9a4d084e7e0f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3cf527f6e0b2cbb70daa9a4d084e7e0f"></a>
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_SetRetValsF</b> (<a class="el" href="structRpcInData.html">RpcInData</a> *data, char *result, gboolean retVal)</td></tr>
<tr class="separator:ga3cf527f6e0b2cbb70daa9a4d084e7e0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf071eb756e2020168ae5d07f4ff7beb7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf071eb756e2020168ae5d07f4ff7beb7"></a>
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_UnregisterCallback</b> (<a class="el" href="structRpcChannel.html">RpcChannel</a> *chan, <a class="el" href="structRpcChannelCallback.html">RpcChannelCallback</a> *rpc)</td></tr>
<tr class="separator:gaf071eb756e2020168ae5d07f4ff7beb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga79bcbad51729149e6834a2585aace4f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga79bcbad51729149e6834a2585aace4f5"></a>
<a class="el" href="structRpcChannel.html">RpcChannel</a> * </td><td class="memItemRight" valign="bottom"><b>BackdoorChannel_New</b> (void)</td></tr>
<tr class="separator:ga79bcbad51729149e6834a2585aace4f5"><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 interface between applications and the underlying GuestRPC channel. The goal is to have an abstraction so applications can run over the backdoor, VMCI sockets or TCP/IP sockets by just picking up the desired channel at runtime, without the need to modify the code.</p>
<p>For this reason, the behavior of all channels is modeled after the RpcIn channel currently used in Tools, so the socket-based channels won't provide much better functionality than what the backdoor provides (aside from being interrupt-based rather than poll-based). </p>
</div></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>
