<html>
<head>
<title>Ecore: Ecore Connection 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>Ecore Connection Client Functions</h1>
<p>Functions that operate on Ecore connection 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__Con__Client__Group.html#ga166fd469acaa809faa4247b12d79278f">ecore_con_client_send</a> (<a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> *cl, const void *data, int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends the given data to the given client. <a href="#ga166fd469acaa809faa4247b12d79278f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI <a class="el" href="Ecore__Con_8h.html#a8254d59597add481f0e2471a845f4231">Ecore_Con_Server</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__Con__Client__Group.html#ga5d19742ffbfeb987c57d8a4093cce7e6">ecore_con_client_server_get</a> (<a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> *cl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the server representing the socket the client has connected to. <a href="#ga5d19742ffbfeb987c57d8a4093cce7e6"></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__Con__Client__Group.html#ga6ceed1117e823d3d3dc0d9a2df825464">ecore_con_client_del</a> (<a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> *cl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the connection and frees memory allocated to the given client. <a href="#ga6ceed1117e823d3d3dc0d9a2df825464"></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__Con__Client__Group.html#ga0c81c3b201d7fa6d48b6f5e99a651edc">ecore_con_client_data_set</a> (<a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> *cl, const void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the data associated with the given client to <code>data</code>. <a href="#ga0c81c3b201d7fa6d48b6f5e99a651edc"></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__Con__Client__Group.html#gae0ee35b9dcbd7e654504baffe4070488">ecore_con_client_data_get</a> (<a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> *cl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the data associated with the given client. <a href="#gae0ee35b9dcbd7e654504baffe4070488"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__Con__Client__Group.html#ga18cb123f1d62299bdfc739b2d1124e14">ecore_con_client_ip_get</a> (<a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> *cl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the IP address of a cleint that has connected. <a href="#ga18cb123f1d62299bdfc739b2d1124e14"></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__Con__Client__Group.html#gaccf37688bb1ecbedc8791b5b43c1595c">ecore_con_client_flush</a> (<a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> *cl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes all pending data to the given client. <a href="#gaccf37688bb1ecbedc8791b5b43c1595c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__Con__Client__Group.html#ga246f73d6f24a651bd6fd5790a4e90064">ecore_con_ssl_available_get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if SSL support is available. <a href="#ga246f73d6f24a651bd6fd5790a4e90064"></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__Con__Client__Group.html#gaad8e029c00a1a4a6097f5ff17dec3c2e">ecore_ipc_ssl_available_get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if SSL support is available. <a href="#gaad8e029c00a1a4a6097f5ff17dec3c2e"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions that operate on Ecore connection client objects. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gae0ee35b9dcbd7e654504baffe4070488"></a><!-- doxytag: member="ecore_con.c::ecore_con_client_data_get" ref="gae0ee35b9dcbd7e654504baffe4070488" args="(Ecore_Con_Client *cl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void* ecore_con_client_data_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> * </td>
<td class="paramname"> <em>cl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the data associated with the given 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 <code>cl</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0c81c3b201d7fa6d48b6f5e99a651edc"></a><!-- doxytag: member="ecore_con.c::ecore_con_client_data_set" ref="ga0c81c3b201d7fa6d48b6f5e99a651edc" args="(Ecore_Con_Client *cl, const void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_con_client_data_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_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 data associated with the given 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 client. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>What to set the data to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga6ceed1117e823d3d3dc0d9a2df825464"></a><!-- doxytag: member="ecore_con.c::ecore_con_client_del" ref="ga6ceed1117e823d3d3dc0d9a2df825464" args="(Ecore_Con_Client *cl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void* ecore_con_client_del </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_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 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__main_8c_source.html#l00319">ecore_main_fd_handler_del()</a>.</p>
<p>Referenced by <a class="el" href="ecore__ipc_8c_source.html#l00861">ecore_ipc_client_del()</a>.</p>
</div>
</div>
<a class="anchor" id="gaccf37688bb1ecbedc8791b5b43c1595c"></a><!-- doxytag: member="ecore_con.c::ecore_con_client_flush" ref="gaccf37688bb1ecbedc8791b5b43c1595c" args="(Ecore_Con_Client *cl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_con_client_flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> * </td>
<td class="paramname"> <em>cl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flushes all pending data to the given client. </p>
<p>Will return when done.</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>
<p>Referenced by <a class="el" href="ecore__ipc_8c_source.html#l00990">ecore_ipc_client_flush()</a>.</p>
</div>
</div>
<a class="anchor" id="ga18cb123f1d62299bdfc739b2d1124e14"></a><!-- doxytag: member="ecore_con.c::ecore_con_client_ip_get" ref="ga18cb123f1d62299bdfc739b2d1124e14" args="(Ecore_Con_Client *cl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI char* ecore_con_client_ip_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> * </td>
<td class="paramname"> <em>cl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the IP address of a cleint that has 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>cl</em> </td><td>The given client. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to an internal string that contains the IP address of the connected client in the form "XXX.YYY.ZZZ.AAA" IP notation. This string should not be modified or trusted to stay valid after deletion for the <code>cl</code> object. If no IP is known NULL is returned. </dd></dl>
<p>Referenced by <a class="el" href="ecore__ipc_8c_source.html#l00972">ecore_ipc_client_ip_get()</a>.</p>
</div>
</div>
<a class="anchor" id="ga166fd469acaa809faa4247b12d79278f"></a><!-- doxytag: member="ecore_con.c::ecore_con_client_send" ref="ga166fd469acaa809faa4247b12d79278f" args="(Ecore_Con_Client *cl, const void *data, int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI int ecore_con_client_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_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>
</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 the given data to the given 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>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The given data. </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>
<p>References <a class="el" href="Ecore_8h_source.html#l00110">ECORE_FD_READ</a>, <a class="el" href="Ecore_8h_source.html#l00111">ECORE_FD_WRITE</a>, and <a class="el" href="ecore__main_8c_source.html#l00419">ecore_main_fd_handler_active_set()</a>.</p>
<p>Referenced by <a class="el" href="ecore__ipc_8c_source.html#l00794">ecore_ipc_client_send()</a>.</p>
</div>
</div>
<a class="anchor" id="ga5d19742ffbfeb987c57d8a4093cce7e6"></a><!-- doxytag: member="ecore_con.c::ecore_con_client_server_get" ref="ga5d19742ffbfeb987c57d8a4093cce7e6" args="(Ecore_Con_Client *cl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI <a class="el" href="Ecore__Con_8h.html#a8254d59597add481f0e2471a845f4231">Ecore_Con_Server</a>* ecore_con_client_server_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Ecore__Con_8h.html#aa7126b0163113e6f3f18d9bda2dda423">Ecore_Con_Client</a> * </td>
<td class="paramname"> <em>cl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the server representing the socket the client has 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 client. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The server that the client connected to. </dd></dl>
<p>Referenced by <a class="el" href="ecore__ipc_8c_source.html#l00861">ecore_ipc_client_del()</a>, and <a class="el" href="ecore__ipc_8c_source.html#l00842">ecore_ipc_client_server_get()</a>.</p>
</div>
</div>
<a class="anchor" id="ga246f73d6f24a651bd6fd5790a4e90064"></a><!-- doxytag: member="ecore_con_ssl.c::ecore_con_ssl_available_get" ref="ga246f73d6f24a651bd6fd5790a4e90064" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ecore_con_ssl_available_get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns if SSL support is available. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if SSL is available, 0 if it is not. </dd></dl>
<p>Referenced by <a class="el" href="ecore__ipc_8c_source.html#l01007">ecore_ipc_ssl_available_get()</a>.</p>
</div>
</div>
<a class="anchor" id="gaad8e029c00a1a4a6097f5ff17dec3c2e"></a><!-- doxytag: member="ecore_ipc.c::ecore_ipc_ssl_available_get" ref="gaad8e029c00a1a4a6097f5ff17dec3c2e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI int ecore_ipc_ssl_available_get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns if SSL support is available. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if SSL is available, 0 if it is not. </dd></dl>
<p>References <a class="el" href="ecore__con__ssl_8c_source.html#l00097">ecore_con_ssl_available_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>
