<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>open-vm-tools 10.1.5: 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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">open-vm-tools 10.1.5
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></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="#enum-members">Enumerations</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>
</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">
#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:ga2f9708c1d108ace3a6a09c9501e67150"><td class="memItemLeft" align="right" valign="top">
typedef struct _RpcChannel </td><td class="memItemRight" valign="bottom"><b>RpcChannel</b></td></tr>
<tr class="separator:ga2f9708c1d108ace3a6a09c9501e67150"><td class="memSeparator" colspan="2"> </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:ga16d9960ad239c7e5ace9e0b1eebb62f5"><td class="memItemLeft" align="right" valign="top">
typedef enum RpcChannelType </td><td class="memItemRight" valign="bottom"><b>RpcChannelType</b></td></tr>
<tr class="separator:ga16d9960ad239c7e5ace9e0b1eebb62f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2483cc5e045448589b94cc70bc99f323"><td class="memItemLeft" align="right" valign="top">typedef gboolean(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#ga2483cc5e045448589b94cc70bc99f323">RpcIn_Callback</a>) (<a class="el" href="structRpcInData.html">RpcInData</a> *data)</td></tr>
<tr class="separator:ga2483cc5e045448589b94cc70bc99f323"><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:gae0e85ceaa9a0f0dfeaedf96b9240f4ff"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__guestrpc.html#gae0e85ceaa9a0f0dfeaedf96b9240f4ff">RpcChannelResetCb</a>) (RpcChannel *chan, gboolean success, gpointer data)</td></tr>
<tr class="separator:gae0e85ceaa9a0f0dfeaedf96b9240f4ff"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga47958f2892536aeba7980802526d4398"><td class="memItemLeft" align="right" valign="top"><a id="ga47958f2892536aeba7980802526d4398"></a>enum  </td><td class="memItemRight" valign="bottom"><b>RpcChannelType</b> { <b>RPCCHANNEL_TYPE_INACTIVE</b>,
<b>RPCCHANNEL_TYPE_BKDOOR</b>,
<b>RPCCHANNEL_TYPE_PRIV_VSOCK</b>,
<b>RPCCHANNEL_TYPE_UNPRIV_VSOCK</b>
}</td></tr>
<tr class="separator:ga47958f2892536aeba7980802526d4398"><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:ga77563edee6811b694806b5659350fd76"><td class="memItemLeft" align="right" valign="top">
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Start</b> (RpcChannel *chan)</td></tr>
<tr class="separator:ga77563edee6811b694806b5659350fd76"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb62306a83db6fa84169f31d9a4dc411"><td class="memItemLeft" align="right" valign="top">
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Stop</b> (RpcChannel *chan)</td></tr>
<tr class="separator:gabb62306a83db6fa84169f31d9a4dc411"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaed9f338d8e571f413d15e01498d3818a"><td class="memItemLeft" align="right" valign="top">
RpcChannelType </td><td class="memItemRight" valign="bottom"><b>RpcChannel_GetType</b> (RpcChannel *chan)</td></tr>
<tr class="separator:gaed9f338d8e571f413d15e01498d3818a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1688da8e049a3884f513c7bcfa91fbe"><td class="memItemLeft" align="right" valign="top">
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Send</b> (RpcChannel *chan, char const *data, size_t dataLen, char **result, size_t *resultLen)</td></tr>
<tr class="separator:gaa1688da8e049a3884f513c7bcfa91fbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab6f9e6871f86456c100f81bb56214436"><td class="memItemLeft" align="right" valign="top">
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Free</b> (void *ptr)</td></tr>
<tr class="separator:gab6f9e6871f86456c100f81bb56214436"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa51fcf3f9e8c8ca0d880c259f2cf6918"><td class="memItemLeft" align="right" valign="top">
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">
RpcChannel * </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:ga5a3e067fe6e787cbea65360d172db686"><td class="memItemLeft" align="right" valign="top">
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Shutdown</b> (RpcChannel *chan)</td></tr>
<tr class="separator:ga5a3e067fe6e787cbea65360d172db686"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga54aa7166d2accef8e107601fa0f957ae"><td class="memItemLeft" align="right" valign="top">
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Destroy</b> (RpcChannel *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">
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">
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_Setup</b> (RpcChannel *chan, const gchar *appName, GMainContext *mainCtx, gpointer appCtx, <a class="el" href="group__vmtools__guestrpc.html#gae0e85ceaa9a0f0dfeaedf96b9240f4ff">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">
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_RegisterCallback</b> (RpcChannel *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">
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">
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">
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_UnregisterCallback</b> (RpcChannel *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:gac2bf78610de4673782cf82cab54e4da2"><td class="memItemLeft" align="right" valign="top">
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_SendOneRaw</b> (const char *data, size_t dataLen, char **result, size_t *resultLen)</td></tr>
<tr class="separator:gac2bf78610de4673782cf82cab54e4da2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ebc1f87457e9951dddee0973363fe62"><td class="memItemLeft" align="right" valign="top">
gboolean </td><td class="memItemRight" valign="bottom"><b>RpcChannel_SendOne</b> (char **reply, size_t *repLen, const char *reqFmt,...)</td></tr>
<tr class="separator:ga4ebc1f87457e9951dddee0973363fe62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab3299bb9bcc04522271d7315b0dff815"><td class="memItemLeft" align="right" valign="top">
RpcChannel * </td><td class="memItemRight" valign="bottom"><b>RpcChannel_New</b> (void)</td></tr>
<tr class="separator:gab3299bb9bcc04522271d7315b0dff815"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8a9fee6e40c1f40e7c2d6e15786cfea6"><td class="memItemLeft" align="right" valign="top">
void </td><td class="memItemRight" valign="bottom"><b>RpcChannel_SetBackdoorOnly</b> (void)</td></tr>
<tr class="separator:ga8a9fee6e40c1f40e7c2d6e15786cfea6"><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, vSockets 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 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
