Click here to Skip to main content
15,896,410 members
Search within:


Articles / Programming Languages / C++
 

RCF - Interprocess Communication for C++

Rate me:
Please Sign up or sign in to vote.
4.94/5 (147 votes)
25 Oct 2011CPOL20 min read 4.7M   8.4K   331  
A server/client IPC framework, using the C++ preprocessor as an IDL compiler.
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>RCF: RCF::UdpEndpoint Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs">
  <ul>
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  </ul></div>
<div class="nav">
<b>RCF</b>::<a class="el" href="class_r_c_f_1_1_udp_endpoint.html">UdpEndpoint</a></div>
<h1>RCF::UdpEndpoint Class Reference</h1><!-- doxytag: class="RCF::UdpEndpoint" --><!-- doxytag: inherits="RCF::I_Endpoint" --><code>#include &lt;<a class="el" href="_udp_endpoint_8hpp-source.html">UdpEndpoint.hpp</a>&gt;</code>
<p>
<p>Inheritance diagram for RCF::UdpEndpoint:
<p><center><img src="class_r_c_f_1_1_udp_endpoint.png" usemap="#RCF::UdpEndpoint_map" border="0" alt=""></center>
<map name="RCF::UdpEndpoint_map">
<area href="class_r_c_f_1_1_i___endpoint.html" alt="RCF::I_Endpoint" shape="rect" coords="0,0,114,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a UDP communications endpoint. 
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#67a0e6dc0fc8c0be20445b8eb4f5f7ef">UdpEndpoint</a> (int port)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#67a0e6dc0fc8c0be20445b8eb4f5f7ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#97b1fc09545ddd3276b113e2fb389928">UdpEndpoint</a> (const std::string &amp;ip, int port)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#97b1fc09545ddd3276b113e2fb389928"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#95e8f9c65efa98338e55dc501cfa6426">UdpEndpoint</a> (const <a class="el" href="class_r_c_f_1_1_udp_endpoint.html">UdpEndpoint</a> &amp;rhs)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#95e8f9c65efa98338e55dc501cfa6426"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::auto_ptr&lt; <a class="el" href="class_r_c_f_1_1_i___server_transport.html">I_ServerTransport</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#49c8906dbba15ca0650d5b530f4567ce">createServerTransport</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a server transport.  <a href="#49c8906dbba15ca0650d5b530f4567ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::auto_ptr&lt; <a class="el" href="class_r_c_f_1_1_i___client_transport.html">I_ClientTransport</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#bea0d2bd8351e96d7442bc218b168462">createClientTransport</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a client transport.  <a href="#bea0d2bd8351e96d7442bc218b168462"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boost::shared_ptr&lt; <a class="el" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#d15aa9ec2223a9b7fccf13523aed37e6">clone</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clones this endpoint.  <a href="#d15aa9ec2223a9b7fccf13523aed37e6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#9331554549ec4a2a3f261619179c3280">getIp</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns IP number of this endpoint.  <a href="#9331554549ec4a2a3f261619179c3280"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#e8ca08cc7c3c15921636e5025de95b98">getPort</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns port number of this endpoint.  <a href="#e8ca08cc7c3c15921636e5025de95b98"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="e3d9019f99e7a02201dab2b4e0d17b68"></a><!-- doxytag: member="RCF::UdpEndpoint::serialize" ref="e3d9019f99e7a02201dab2b4e0d17b68" args="(Archive &amp;ar, const unsigned int)" -->
template&lt;typename Archive&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_udp_endpoint.html#e3d9019f99e7a02201dab2b4e0d17b68">serialize</a> (Archive &amp;ar, const unsigned int)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Serializes the <a class="el" href="class_r_c_f_1_1_udp_endpoint.html">UdpEndpoint</a> object. <br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="67a0e6dc0fc8c0be20445b8eb4f5f7ef"></a><!-- doxytag: member="RCF::UdpEndpoint::UdpEndpoint" ref="67a0e6dc0fc8c0be20445b8eb4f5f7ef" args="(int port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">RCF::UdpEndpoint::UdpEndpoint           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>port</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>UDP port number of the endpoint. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="97b1fc09545ddd3276b113e2fb389928"></a><!-- doxytag: member="RCF::UdpEndpoint::UdpEndpoint" ref="97b1fc09545ddd3276b113e2fb389928" args="(const std::string &amp;ip, int port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">RCF::UdpEndpoint::UdpEndpoint           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>ip</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>port</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ip</em>&nbsp;</td><td>IP number of the endpoint. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>UDP port number of the endpoint. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="95e8f9c65efa98338e55dc501cfa6426"></a><!-- doxytag: member="RCF::UdpEndpoint::UdpEndpoint" ref="95e8f9c65efa98338e55dc501cfa6426" args="(const UdpEndpoint &amp;rhs)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">RCF::UdpEndpoint::UdpEndpoint           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="class_r_c_f_1_1_udp_endpoint.html">UdpEndpoint</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Copy constructor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>rhs</em>&nbsp;</td><td><a class="el" href="class_r_c_f_1_1_udp_endpoint.html">UdpEndpoint</a> object to construct this object from. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d15aa9ec2223a9b7fccf13523aed37e6"></a><!-- doxytag: member="RCF::UdpEndpoint::clone" ref="d15aa9ec2223a9b7fccf13523aed37e6" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">boost::shared_ptr&lt;<a class="el" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a>&gt; RCF::UdpEndpoint::clone           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Clones this endpoint. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Shared pointer to a new <a class="el" href="class_r_c_f_1_1_udp_endpoint.html">UdpEndpoint</a> object. </dd></dl>

<p>
Implements <a class="el" href="class_r_c_f_1_1_i___endpoint.html#0a731ec0f11d499c652e49312cd4a92b">RCF::I_Endpoint</a>.    </td>
  </tr>
</table>
<a class="anchor" name="bea0d2bd8351e96d7442bc218b168462"></a><!-- doxytag: member="RCF::UdpEndpoint::createClientTransport" ref="bea0d2bd8351e96d7442bc218b168462" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">std::auto_ptr&lt;<a class="el" href="class_r_c_f_1_1_i___client_transport.html">I_ClientTransport</a>&gt; RCF::UdpEndpoint::createClientTransport           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Creates a client transport. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Auto pointer to client transport. </dd></dl>

<p>
Implements <a class="el" href="class_r_c_f_1_1_i___endpoint.html#4a4fda3406be43e8d0ba126074090091">RCF::I_Endpoint</a>.    </td>
  </tr>
</table>
<a class="anchor" name="49c8906dbba15ca0650d5b530f4567ce"></a><!-- doxytag: member="RCF::UdpEndpoint::createServerTransport" ref="49c8906dbba15ca0650d5b530f4567ce" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">std::auto_ptr&lt;<a class="el" href="class_r_c_f_1_1_i___server_transport.html">I_ServerTransport</a>&gt; RCF::UdpEndpoint::createServerTransport           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Creates a server transport. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Auto pointer to server transport. </dd></dl>

<p>
Implements <a class="el" href="class_r_c_f_1_1_i___endpoint.html#badcb8c3b425347c373d22cf0b00b6e2">RCF::I_Endpoint</a>.    </td>
  </tr>
</table>
<a class="anchor" name="9331554549ec4a2a3f261619179c3280"></a><!-- doxytag: member="RCF::UdpEndpoint::getIp" ref="9331554549ec4a2a3f261619179c3280" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">std::string RCF::UdpEndpoint::getIp           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns IP number of this endpoint. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>IP number of this endpoint. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="e8ca08cc7c3c15921636e5025de95b98"></a><!-- doxytag: member="RCF::UdpEndpoint::getPort" ref="e8ca08cc7c3c15921636e5025de95b98" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">int RCF::UdpEndpoint::getPort           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns port number of this endpoint. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>port number of this endpoint. </dd></dl>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_udp_endpoint_8hpp-source.html">UdpEndpoint.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Sep 19 19:02:39 2006 for RCF by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Jarl Lindrud
Australia Australia
Software developer, from Sweden and now living in Canberra, Australia, working on distributed C++ applications. When he is not programming, Jarl enjoys skiing and playing table tennis. He derives immense satisfaction from referring to himself in third person.

Comments and Discussions

Permalink
Advertise
Privacy
Cookies
Terms of Use
Layout: fixed | fluid

Posted 23 Dec 2005

Article Copyright 2005 by Jarl Lindrud
Everything else Copyright © CodeProject, 1999-2024

Web03 2.8:2024-04-02:1