<html>
<head>
<title>Ecore: IPC Client Functions</title>
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
<meta name="author" content="Andres Blanc" >
<link rel="icon" href="img/favicon.png" type="image/x-icon">
<link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
<link rel="icon" href="img/favicon.png" type="image/ico">
<link rel="shortcut icon" href="img/favicon.png" type="image/ico">
<link rel="stylesheet" type="text/css" href="e.css">
<link rel="stylesheet" type="text/css" href="edoxy.css">
</head>
<body>
<div id="container">
<div id="header">
<div class="layout">
<h1><span>Enlightenment</span></h1>
<h2><span>Beauty at your fingertips</span></h2>
<table cellspacing="0" cellpadding="0" width="100%"><tr>
<td id="header_logo">
<a href="http://www.enlightenment.org"></a>
</td>
<td id="header_menu">
<table cellspacing="0" cellpadding="0" align="right"><tr>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=home">Home</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=news">News</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=about">About</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=download">Download</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=support">Support</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contact">Contact</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://trac.enlightenment.org/e">Tracker</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=docs">Docs</a></td>
</tr></table>
</td>
<td id="header_last"></td>
</tr></table>
<div class="doxytitle">
Ecore Documentation <small>at 2 Jul 2010</small>
</div>
<div class="menu-container">
<div class="submenu">
<ul class="current">
<li><a href="files.html">Files</a></li>
<li><a href="annotated.html">Data Structures</a></li>
<li><a href="globals.html">Globals</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="pages.html">Related Pages</a></li>
<li class="current"><a href="index.html">Main Page</a></li>
</ul>
</div>
</div>
<div class="clear"></div>
</div>
</div>
<div id="content">
<div class="layout">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="contents">
<h1>IPC Client Functions</h1>
<p>Functions that deal with IPC client objects.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IPC__Client__Group.html#ga982c4fa7ecccfb5e89bb6d368a74fd2a">ecore_ipc_client_send</a> (<a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a message to the given IPC client. <a href="#ga982c4fa7ecccfb5e89bb6d368a74fd2a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI <a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IPC__Client__Group.html#ga6fef6153dc1ed497d78265103518feed">ecore_ipc_client_server_get</a> (<a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> *cl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the IPC server that the given IPC client is connected to. <a href="#ga6fef6153dc1ed497d78265103518feed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IPC__Client__Group.html#ga33d563f3d055c9dbec3d3200cce36913">ecore_ipc_client_del</a> (<a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> *cl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the connection and frees memory allocated to the given IPC client. <a href="#ga33d563f3d055c9dbec3d3200cce36913"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IPC__Client__Group.html#ga7cdfcf0051c9d1bcc7e72aac33a0acd7">ecore_ipc_client_data_set</a> (<a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> *cl, const void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the IPC data associated with the given IPC client to <code>data</code>. <a href="#ga7cdfcf0051c9d1bcc7e72aac33a0acd7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IPC__Client__Group.html#gab3285d8275d0662676c55f612dbaa49f">ecore_ipc_client_data_get</a> (<a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> *cl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the data that has been associated with the given IPC client. <a href="#gab3285d8275d0662676c55f612dbaa49f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions that deal with IPC client objects. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gab3285d8275d0662676c55f612dbaa49f"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_client_data_get" ref="gab3285d8275d0662676c55f612dbaa49f" args="(Ecore_Ipc_Client *cl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void* ecore_ipc_client_data_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> * </td>
<td class="paramname"> <em>cl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the data that has been associated with the given IPC client. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cl</em> </td><td>The given client. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The data associated with the IPC client. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7cdfcf0051c9d1bcc7e72aac33a0acd7"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_client_data_set" ref="ga7cdfcf0051c9d1bcc7e72aac33a0acd7" args="(Ecore_Ipc_Client *cl, const void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_ipc_client_data_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> * </td>
<td class="paramname"> <em>cl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the IPC data associated with the given IPC client to <code>data</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cl</em> </td><td>The given IPC client. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to associate with the IPC client. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga33d563f3d055c9dbec3d3200cce36913"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_client_del" ref="ga33d563f3d055c9dbec3d3200cce36913" args="(Ecore_Ipc_Client *cl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void* ecore_ipc_client_del </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> * </td>
<td class="paramname"> <em>cl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the connection and frees memory allocated to the given IPC client. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cl</em> </td><td>The given client. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Data associated with the client. </dd></dl>
<p>References <a class="el" href="ecore__con_8c_source.html#l00638">ecore_con_client_del()</a>, <a class="el" href="ecore__con_8c_source.html#l00621">ecore_con_client_server_get()</a>, and <a class="el" href="ecore__con_8c_source.html#l00400">ecore_con_server_data_get()</a>.</p>
<p>Referenced by <a class="el" href="ecore__ipc_8c_source.html#l00449">ecore_ipc_server_del()</a>.</p>
</div>
</div>
<a class="anchor" id="ga982c4fa7ecccfb5e89bb6d368a74fd2a"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_client_send" ref="ga982c4fa7ecccfb5e89bb6d368a74fd2a" args="(Ecore_Ipc_Client *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI int ecore_ipc_client_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> * </td>
<td class="paramname"> <em>cl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>major</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>minor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ref_to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>response</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends a message to the given IPC client. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cl</em> </td><td>The given IPC client. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>major</em> </td><td>Major opcode of the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>minor</em> </td><td>Minor opcode of the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ref</em> </td><td>Reference number of the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ref_to</em> </td><td>Reference number of the message this message refers to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>response</em> </td><td>Requires response. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to send as part of the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Length of the data, in bytes, to send. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes sent. <code>0</code> will be returned if there is an error.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd><p class="startdd">This function needs to become an IPC message. </p>
<p class="enddd">Make sure ref_to and response parameters are described correctly. </p>
</dd></dl>
<p>References <a class="el" href="ecore__con_8c_source.html#l00576">ecore_con_client_send()</a>.</p>
</div>
</div>
<a class="anchor" id="ga6fef6153dc1ed497d78265103518feed"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_client_server_get" ref="ga6fef6153dc1ed497d78265103518feed" args="(Ecore_Ipc_Client *cl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI <a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a>* ecore_ipc_client_server_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#a907f972d57d41ff33fc6eb2a37be9ae8">Ecore_Ipc_Client</a> * </td>
<td class="paramname"> <em>cl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the IPC server that the given IPC client is connected to. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cl</em> </td><td>The given IPC client. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The IPC server the IPC client is connected to. </dd></dl>
<p>References <a class="el" href="ecore__con_8c_source.html#l00621">ecore_con_client_server_get()</a>, and <a class="el" href="ecore__con_8c_source.html#l00400">ecore_con_server_data_get()</a>.</p>
</div>
</div>
</div>
<div id="push"></div>
</div> <!-- #content -->
</div> <!-- .layout -->
</div> <!-- #container -->
<div id="footer">
<table><tr>
<td class="copyright">Copyright ©2010 Enlightenment</td>
<td class="generated">Docs generated Fri Jul 2 12:11:49 2010</td>
</tr></table>
</div>
</body>
</html>
