Click here to Skip to main content
15,893,381 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.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_SessionManager 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___session_manager.html">I_SessionManager</a></div>
<h1>RCF::I_SessionManager Class Reference</h1><!-- doxytag: class="RCF::I_SessionManager" --><code>#include &lt;<a class="el" href="_server_transport_8hpp-source.html">ServerTransport.hpp</a>&gt;</code>
<p>
<p>Inheritance diagram for RCF::I_SessionManager:
<p><center><img src="class_r_c_f_1_1_i___session_manager.png" usemap="#RCF::I_SessionManager_map" border="0" alt=""></center>
<map name="RCF::I_SessionManager_map">
<area href="class_r_c_f_1_1_rcf_server.html" alt="RCF::RcfServer" shape="rect" coords="0,56,148,80">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for session managers, in particular <a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a>. 
<p>
Server transports use <a class="el" href="class_r_c_f_1_1_i___session_manager.html">I_SessionManager</a> to communicate with the <a class="el" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> class. 
<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="77285a91341777edeb4e1a19c859eeb8"></a><!-- doxytag: member="RCF::I_SessionManager::~I_SessionManager" ref="77285a91341777edeb4e1a19c859eeb8" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___session_manager.html#77285a91341777edeb4e1a19c859eeb8">~I_SessionManager</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual boost::shared_ptr&lt;<br>
 <a class="el" href="class_r_c_f_1_1_i___session.html">I_Session</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_i___session_manager.html#b3d49eb5ed9e90e9240dd507157549e7">createSession</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Requests the session manager to create a new session.  <a href="#b3d49eb5ed9e90e9240dd507157549e7"></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___session_manager.html#bf73ae1653f1b075ecdeacb4404e86d9">onReadCompleted</a> (boost::shared_ptr&lt; <a class="el" href="class_r_c_f_1_1_i___session.html">I_Session</a> &gt; sessionPtr)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback, by which the server transport indicates that a read operation has completed on the session.  <a href="#bf73ae1653f1b075ecdeacb4404e86d9"></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___session_manager.html#5059ed49ed1d06ce6e02064bd0801a72">onWriteCompleted</a> (boost::shared_ptr&lt; <a class="el" href="class_r_c_f_1_1_i___session.html">I_Session</a> &gt; sessionPtr)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback, by which the server transport indicates that a write operation has completed on the session.  <a href="#5059ed49ed1d06ce6e02064bd0801a72"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b3d49eb5ed9e90e9240dd507157549e7"></a><!-- doxytag: member="RCF::I_SessionManager::createSession" ref="b3d49eb5ed9e90e9240dd507157549e7" args="()=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 boost::shared_ptr&lt;<a class="el" href="class_r_c_f_1_1_i___session.html">I_Session</a>&gt; RCF::I_SessionManager::createSession           </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><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Requests the session manager to create a new session. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Pointer to newly created session. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="bf73ae1653f1b075ecdeacb4404e86d9"></a><!-- doxytag: member="RCF::I_SessionManager::onReadCompleted" ref="bf73ae1653f1b075ecdeacb4404e86d9" args="(boost::shared_ptr&lt; I_Session &gt; sessionPtr)=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_SessionManager::onReadCompleted           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">boost::shared_ptr&lt; <a class="el" href="class_r_c_f_1_1_i___session.html">I_Session</a> &gt;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>sessionPtr</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>
Callback, by which the server transport indicates that a read operation has completed on the session. 
<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>sessionPtr</em>&nbsp;</td><td>Session for which the read operation has completed. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="5059ed49ed1d06ce6e02064bd0801a72"></a><!-- doxytag: member="RCF::I_SessionManager::onWriteCompleted" ref="5059ed49ed1d06ce6e02064bd0801a72" args="(boost::shared_ptr&lt; I_Session &gt; sessionPtr)=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_SessionManager::onWriteCompleted           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">boost::shared_ptr&lt; <a class="el" href="class_r_c_f_1_1_i___session.html">I_Session</a> &gt;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>sessionPtr</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>
Callback, by which the server transport indicates that a write operation has completed on the session. 
<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>sessionPtr</em>&nbsp;</td><td>Session for which the write operation has completed. </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="_server_transport_8hpp-source.html">ServerTransport.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

Web02 2.8:2024-04-02:1