<!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"/>
<title>edelib: SipcClient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">edelib
 <span id="projectnumber">2.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceedelib.html">edelib</a> </li>
<li class="navelem"><a class="el" href="classedelib_1_1SipcClient.html">SipcClient</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">SipcClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="edelib::SipcClient" -->
<p>Simple IPC client.
<a href="classedelib_1_1SipcClient.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Sipc_8h_source.html">edelib/Sipc.h</a>></code></p>
<p><a href="classedelib_1_1SipcClient-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1SipcClient.html#a11938aaeb84f67bf180cfb1ef319fe35">SipcClient</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1SipcClient.html#a9c92fd08677ed4389676d9a6934b6a42">~SipcClient</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1SipcClient.html#a24dfaef44686c9c4da311627f647584a">connect</a> (const char *prefix)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1SipcClient.html#a2db964e8617db9ad3168829089db9309">send</a> (const char *msg)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Simple IPC client. </p>
<p>A client side of this simple IPC implementation. Clients will connects on the names servers are using and send textual messages to them.</p>
<p>Here is the sample: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classedelib_1_1SipcClient.html#a11938aaeb84f67bf180cfb1ef319fe35">SipcClient</a> c;
<span class="keywordflow">if</span>(!c.connect(<span class="stringliteral">"demo"</span>))
<span class="comment">// fail</span>
c.send(<span class="stringliteral">"howdy"</span>);
</pre></div><dl class="note"><dt><b>Note:</b></dt><dd>Message length is currently is limited to 1024 bytes. </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a11938aaeb84f67bf180cfb1ef319fe35"></a><!-- doxytag: member="edelib::SipcClient::SipcClient" ref="a11938aaeb84f67bf180cfb1ef319fe35" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1SipcClient.html">SipcClient</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor; prepares internal data </p>
</div>
</div>
<a class="anchor" id="a9c92fd08677ed4389676d9a6934b6a42"></a><!-- doxytag: member="edelib::SipcClient::~SipcClient" ref="a9c92fd08677ed4389676d9a6934b6a42" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classedelib_1_1SipcClient.html">SipcClient</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cleans internal stuff, closes connections </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a24dfaef44686c9c4da311627f647584a"></a><!-- doxytag: member="edelib::SipcClient::connect" ref="a24dfaef44686c9c4da311627f647584a" args="(const char *prefix)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classedelib_1_1SipcClient.html#a24dfaef44686c9c4da311627f647584a">connect</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>prefix</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects to the given name</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>false if name does not exists or some error occured </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">prefix</td><td>is name to be connected to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2db964e8617db9ad3168829089db9309"></a><!-- doxytag: member="edelib::SipcClient::send" ref="a2db964e8617db9ad3168829089db9309" args="(const char *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1SipcClient.html#a2db964e8617db9ad3168829089db9309">send</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends an message</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>is textual message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>edelib/<a class="el" href="Sipc_8h_source.html">Sipc.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 5 2012 17:49:03 for edelib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
