Click here to Skip to main content
15,886,026 members
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.6M   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::I_Service 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_i___service.html">I_Service</a></div>
<h1>RCF::I_Service Class Reference</h1><!-- doxytag: class="RCF::I_Service" --><code>#include &lt;<a class="el" href="_service_8hpp-source.html">Service.hpp</a>&gt;</code>
<p>
<p>Inheritance diagram for RCF::I_Service:
<p><center><img src="class_r_c_f_1_1_i___service.png" usemap="#RCF::I_Service_map" border="0" alt=""></center>
<map name="RCF::I_Service_map">
<area href="class_r_c_f_1_1_filter_service.html" alt="RCF::FilterService" shape="rect" coords="0,56,168,80">
<area href="class_r_c_f_1_1_object_factory_service.html" alt="RCF::ObjectFactoryService" shape="rect" coords="178,56,346,80">
<area href="class_r_c_f_1_1_publishing_service.html" alt="RCF::PublishingService" shape="rect" coords="356,56,524,80">
<area href="class_r_c_f_1_1_subscription_service.html" alt="RCF::SubscriptionService" shape="rect" coords="534,56,702,80">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for <a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> plug-in services. 
<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"><a class="anchor" name="81fcfe4b65b5892055f1629ad79490ed"></a><!-- doxytag: member="RCF::I_Service::I_Service" ref="81fcfe4b65b5892055f1629ad79490ed" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___service.html#81fcfe4b65b5892055f1629ad79490ed">I_Service</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___service.html#af38a713d7d11ff4f0ef29d481802c6a">onServiceAdded</a> (<a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;server)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invoked when the service is added to a server.  <a href="#af38a713d7d11ff4f0ef29d481802c6a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___service.html#caf2d338c2c1f6302eee24f28798a799">onServiceRemoved</a> (<a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;server)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invoked when the service is removed from a server.  <a href="#caf2d338c2c1f6302eee24f28798a799"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___service.html#f4187b1cf785a112d63e870027996ecc">onServerOpen</a> (<a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;server)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invoked when the server is opened.  <a href="#f4187b1cf785a112d63e870027996ecc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___service.html#a9eeb30d90b0b7504615cce71bf0813e">onServerClose</a> (<a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;server)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invoked when the server is closed.  <a href="#a9eeb30d90b0b7504615cce71bf0813e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___service.html#3ae9ab17c55e2ab1813637518766ad90">onServerStart</a> (<a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;server)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invoked when the server is started, before any server transport threads are spawned.  <a href="#3ae9ab17c55e2ab1813637518766ad90"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___service.html#6a3ae677fe9a32eab4d5bc56fe093b54">onServerStop</a> (<a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;server)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invoked when the server is stopped, after all server transport threads have been stopped.  <a href="#6a3ae677fe9a32eab4d5bc56fe093b54"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a9eeb30d90b0b7504615cce71bf0813e"></a><!-- doxytag: member="RCF::I_Service::onServerClose" ref="a9eeb30d90b0b7504615cce71bf0813e" args="(RcfServer &amp;server)" --><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">virtual void RCF::I_Service::onServerClose           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>server</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Invoked when the server is closed. 
<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>server</em>&nbsp;</td><td><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> object to which the service has been added. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="f4187b1cf785a112d63e870027996ecc"></a><!-- doxytag: member="RCF::I_Service::onServerOpen" ref="f4187b1cf785a112d63e870027996ecc" args="(RcfServer &amp;server)" --><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">virtual void RCF::I_Service::onServerOpen           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>server</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Invoked when the server is opened. 
<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>server</em>&nbsp;</td><td><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> object to which the service has been added. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="3ae9ab17c55e2ab1813637518766ad90"></a><!-- doxytag: member="RCF::I_Service::onServerStart" ref="3ae9ab17c55e2ab1813637518766ad90" args="(RcfServer &amp;server)" --><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">virtual void RCF::I_Service::onServerStart           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>server</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Invoked when the server is started, before any server transport threads are spawned. 
<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>server</em>&nbsp;</td><td><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> object to which the service has been added. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="6a3ae677fe9a32eab4d5bc56fe093b54"></a><!-- doxytag: member="RCF::I_Service::onServerStop" ref="6a3ae677fe9a32eab4d5bc56fe093b54" args="(RcfServer &amp;server)" --><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">virtual void RCF::I_Service::onServerStop           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>server</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Invoked when the server is stopped, after all server transport threads have been stopped. 
<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>server</em>&nbsp;</td><td><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> object to which the service has been added. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="af38a713d7d11ff4f0ef29d481802c6a"></a><!-- doxytag: member="RCF::I_Service::onServiceAdded" ref="af38a713d7d11ff4f0ef29d481802c6a" args="(RcfServer &amp;server)=0" --><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">virtual void RCF::I_Service::onServiceAdded           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>server</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Invoked when the service is added to a server. 
<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>server</em>&nbsp;</td><td><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> object to which the service is being added. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="caf2d338c2c1f6302eee24f28798a799"></a><!-- doxytag: member="RCF::I_Service::onServiceRemoved" ref="caf2d338c2c1f6302eee24f28798a799" args="(RcfServer &amp;server)=0" --><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">virtual void RCF::I_Service::onServiceRemoved           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>server</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Invoked when the service is removed from a server. 
<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>server</em>&nbsp;</td><td><a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> object from which the service is being removed. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_service_8hpp-source.html">Service.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
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