<html>
<head>
<title>Ecore: IPC Server 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 Server Functions</h1>
<p>Functions the deal with IPC server 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 <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__Server__Group.html#gaeba705e14ef79c1f824fcc1c184ddadb">ecore_ipc_server_add</a> (Ecore_Ipc_Type compl_type, const char *name, int port, const void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an IPC server that listens for connections. <a href="#gaeba705e14ef79c1f824fcc1c184ddadb"></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__Server__Group.html#gafe02c81940d4e5a464cb32e125887f7e">ecore_ipc_server_connect</a> (Ecore_Ipc_Type compl_type, char *name, int port, const void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an IPC server object to represent the IPC server listening on the given port. <a href="#gafe02c81940d4e5a464cb32e125887f7e"></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__Server__Group.html#ga04148eb8454432091e29b185c68a3eb2">ecore_ipc_server_del</a> (<a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> *svr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the connection and frees the given IPC server. <a href="#ga04148eb8454432091e29b185c68a3eb2"></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__Server__Group.html#gac32fe6a6757a54e6714fb080472f8901">ecore_ipc_server_data_get</a> (<a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> *svr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the data associated with the given IPC server. <a href="#gac32fe6a6757a54e6714fb080472f8901"></a><br/></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__Server__Group.html#gac585ae7ee881855af1f0322eaa5c5108">ecore_ipc_server_connected_get</a> (<a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> *svr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether the given IPC server is currently connected. <a href="#gac585ae7ee881855af1f0322eaa5c5108"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI Eina_List * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IPC__Server__Group.html#gaaca6af31372517b07f184604e3868fdc">ecore_ipc_server_clients_get</a> (<a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> *svr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of clients for this server. <a href="#gaaca6af31372517b07f184604e3868fdc"></a><br/></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__Server__Group.html#ga1fb98acb3bcab778e52bf35f932a5afa">ecore_ipc_server_send</a> (<a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> *svr, 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 server. <a href="#ga1fb98acb3bcab778e52bf35f932a5afa"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions the deal with IPC server objects. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaeba705e14ef79c1f824fcc1c184ddadb"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_server_add" ref="gaeba705e14ef79c1f824fcc1c184ddadb" args="(Ecore_Ipc_Type compl_type, const char *name, int port, const void *data)" -->
<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_server_add </td>
<td>(</td>
<td class="paramtype">Ecore_Ipc_Type </td>
<td class="paramname"> <em>compl_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</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>Creates an IPC server that listens for connections. </p>
<p>For more details about the <code>compl_type</code>, <code>name</code> and <code>port</code> parameters, see the <a class="el" href="group__Ecore__Con__Server__Group.html#gace4c9656c7bd6eef0d29621d6dd75dee">ecore_con_server_add</a> documentation.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>compl_type</em> </td><td>The connection type. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name to associate with the socket used for connection. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>Number to identify with socket used for connection. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Data to associate with the IPC server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>New IPC server. If there is an error, <code>NULL</code> is returned.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>Need to add protocol type parameter to this function. </dd></dl>
<p>References <a class="el" href="ecore__con_8c_source.html#l00193">ecore_con_server_add()</a>.</p>
</div>
</div>
<a class="anchor" id="gaaca6af31372517b07f184604e3868fdc"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_server_clients_get" ref="gaaca6af31372517b07f184604e3868fdc" args="(Ecore_Ipc_Server *svr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI Eina_List* ecore_ipc_server_clients_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> * </td>
<td class="paramname"> <em>svr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the list of clients for this server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svr</em> </td><td>The given IPC server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An Eina_List with the clients. </dd></dl>
</div>
</div>
<a class="anchor" id="gafe02c81940d4e5a464cb32e125887f7e"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_server_connect" ref="gafe02c81940d4e5a464cb32e125887f7e" args="(Ecore_Ipc_Type compl_type, char *name, int port, const void *data)" -->
<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_server_connect </td>
<td>(</td>
<td class="paramtype">Ecore_Ipc_Type </td>
<td class="paramname"> <em>compl_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</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>Creates an IPC server object to represent the IPC server listening on the given port. </p>
<p>For more details about the <code>compl_type</code>, <code>name</code> and <code>port</code> parameters, see the <a class="el" href="group__Ecore__Con__Server__Group.html#ga2cd832b9d0e592559ac13de24634b316">ecore_con_server_connect</a> documentation.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>compl_type</em> </td><td>The IPC connection type. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name used to determine which socket to use for the IPC connection. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>Number used to identify the socket to use for the IPC connection. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Data to associate with the server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new IPC server. <code>NULL</code> is returned on error.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>Need to add protocol type parameter. </dd></dl>
<p>References <a class="el" href="ecore__con_8c_source.html#l00288">ecore_con_server_connect()</a>.</p>
</div>
</div>
<a class="anchor" id="gac585ae7ee881855af1f0322eaa5c5108"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_server_connected_get" ref="gac585ae7ee881855af1f0322eaa5c5108" args="(Ecore_Ipc_Server *svr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI int ecore_ipc_server_connected_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> * </td>
<td class="paramname"> <em>svr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves whether the given IPC server is currently connected. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svr</em> </td><td>The given IPC server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the server is connected. <code>0</code> otherwise. </dd></dl>
<p>References <a class="el" href="ecore__con_8c_source.html#l00418">ecore_con_server_connected_get()</a>.</p>
</div>
</div>
<a class="anchor" id="gac32fe6a6757a54e6714fb080472f8901"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_server_data_get" ref="gac32fe6a6757a54e6714fb080472f8901" args="(Ecore_Ipc_Server *svr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void* ecore_ipc_server_data_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> * </td>
<td class="paramname"> <em>svr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the data associated with the given IPC server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svr</em> </td><td>The given IPC server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The associated data. </dd></dl>
</div>
</div>
<a class="anchor" id="ga04148eb8454432091e29b185c68a3eb2"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_server_del" ref="ga04148eb8454432091e29b185c68a3eb2" args="(Ecore_Ipc_Server *svr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void* ecore_ipc_server_del </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> * </td>
<td class="paramname"> <em>svr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the connection and frees the given IPC server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svr</em> </td><td>The given IPC server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The data associated with the server when it was created. </dd></dl>
<p>References <a class="el" href="ecore__con_8c_source.html#l00364">ecore_con_server_del()</a>, and <a class="el" href="ecore__ipc_8c_source.html#l00861">ecore_ipc_client_del()</a>.</p>
<p>Referenced by <a class="el" href="ecore__ipc_8c_source.html#l00309">ecore_ipc_shutdown()</a>.</p>
</div>
</div>
<a class="anchor" id="ga1fb98acb3bcab778e52bf35f932a5afa"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_server_send" ref="ga1fb98acb3bcab778e52bf35f932a5afa" args="(Ecore_Ipc_Server *svr, 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_server_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Ipc_8h.html#ae7e172a5fc9ae1b60deae8539b802c50">Ecore_Ipc_Server</a> * </td>
<td class="paramname"> <em>svr</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 server. </p>
<p>The content of the parameters, excluding the <code>svr</code> paramter, is up to the 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>svr</em> </td><td>The given IPC server. </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>Message reference number. </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>Number of bytes sent. <code>0</code> is returned if there is an error.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd><p class="startdd">This function needs to become an IPC message. </p>
<p class="enddd">Fix up the documentation: Make sure what ref_to and response are. </p>
</dd></dl>
<p>References <a class="el" href="ecore__con_8c_source.html#l00456">ecore_con_server_send()</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>
