Click here to Skip to main content
15,895,142 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: SerializationProtocol.hpp Source File</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><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li id="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</span></a></li>
  </ul></div>
<div class="nav">
<a class="el" href="dir_G_3A_2FDevelopment_2Fbuild_2Fscripts_2Fwin_2FBuildRcf2_5FOutput_2FRCF_2D0_2E4_2Finclude_2F.html">include</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_G_3A_2FDevelopment_2Fbuild_2Fscripts_2Fwin_2FBuildRcf2_5FOutput_2FRCF_2D0_2E4_2Finclude_2FRCF_2F.html">RCF</a></div>
<h1>SerializationProtocol.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00002"></a>00002 <span class="comment">//*****************************************************************************</span>
<a name="l00003"></a>00003 <span class="comment">// RCF - Remote Call Framework</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (c) 2005. All rights reserved.</span>
<a name="l00005"></a>00005 <span class="comment">// Developed by Jarl Lindrud.</span>
<a name="l00006"></a>00006 <span class="comment">// Contact: jlindrud@hotmail.com .</span>
<a name="l00007"></a>00007 <span class="comment">//*****************************************************************************</span>
<a name="l00008"></a>00008 
<a name="l00009"></a>00009 <span class="preprocessor">#ifndef INCLUDE_RCF_SERIALIZATIONPROTOCOL_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDE_RCF_SERIALIZATIONPROTOCOL_HPP</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &lt;sstream&gt;</span>
<a name="l00014"></a>00014 
<a name="l00015"></a>00015 <span class="comment">// Serialization protocols</span>
<a name="l00016"></a>00016 
<a name="l00017"></a>00017 <span class="preprocessor">#if !defined(RCF_USE_SF_SERIALIZATION) &amp;&amp; !defined(RCF_USE_BOOST_SERIALIZATION)</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define RCF_USE_SF_SERIALIZATION</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#if defined(RCF_USE_SF_SERIALIZATION)</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#include &lt;RCF/Protocol/SF.hpp&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#if defined(RCF_USE_BOOST_SERIALIZATION)</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#include &lt;RCF/Protocol/BoostSerialization.hpp&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#endif</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="keyword">namespace </span>RCF {
<a name="l00030"></a>00030 
<a name="l00031"></a>00031     <span class="keywordtype">bool</span> isSerializationProtocolSupported(<span class="keywordtype">int</span> protocol);
<a name="l00032"></a>00032 
<a name="l00033"></a>00033     std::string getSerializationProtocolName(<span class="keywordtype">int</span> protocol);
<a name="l00034"></a>00034     
<a name="l00035"></a>00035 
<a name="l00036"></a>00036     <span class="keyword">class </span>PointerContext
<a name="l00037"></a>00037     {
<a name="l00038"></a>00038     <span class="keyword">public</span>:
<a name="l00039"></a>00039         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SmartPtr, <span class="keyword">typename</span> T&gt; 
<a name="l00040"></a>00040         SmartPtr get(T t)
<a name="l00041"></a>00041         {
<a name="l00042"></a>00042             <span class="keywordflow">return</span> static_cast&lt;SmartPtr&gt;( ptrMap[&amp;<span class="keyword">typeid</span>(SmartPtr)][ static_cast&lt;void *&gt;(t) ] );
<a name="l00043"></a>00043         }
<a name="l00044"></a>00044 
<a name="l00045"></a>00045         template&lt;typename SmartPtr, typename T&gt; 
<a name="l00046"></a>00046         <span class="keywordtype">void</span> set(SmartPtr sp, T t)
<a name="l00047"></a>00047         {
<a name="l00048"></a>00048             ptrMap[&amp;<span class="keyword">typeid</span>(SmartPtr)][ static_cast&lt;void *&gt;(t) ] = static_cast&lt;void *&gt;(sp);
<a name="l00049"></a>00049         }
<a name="l00050"></a>00050 
<a name="l00051"></a>00051         <span class="keywordtype">void</span> clear()
<a name="l00052"></a>00052         {
<a name="l00053"></a>00053             ptrMap.clear();
<a name="l00054"></a>00054         }
<a name="l00055"></a>00055 
<a name="l00056"></a>00056     <span class="keyword">private</span>:
<a name="l00057"></a>00057         std::map&lt; const std::type_info *, std::map&lt;void*, void*&gt; &gt; ptrMap;
<a name="l00058"></a>00058     };
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 
<a name="l00061"></a>00061     <span class="keyword">class </span>Token;
<a name="l00062"></a>00062     <span class="keyword">class </span>MethodInvocationRequest;
<a name="l00063"></a>00063     <span class="keyword">class </span>MethodInvocationResponse;
<a name="l00064"></a>00064     
<a name="l00065"></a>00065     <span class="keyword">class </span>SerializationProtocolIn
<a name="l00066"></a>00066     {
<a name="l00067"></a>00067     <span class="keyword">public</span>:
<a name="l00068"></a>00068         SerializationProtocolIn();
<a name="l00069"></a>00069         <span class="keywordtype">void</span> setSerializationProtocol(<span class="keywordtype">int</span> protocol);
<a name="l00070"></a>00070         <span class="keywordtype">int</span> getSerializationProtocol();
<a name="l00071"></a>00071         std::string str();
<a name="l00072"></a>00072         <span class="keywordtype">void</span> reset(<span class="keyword">const</span> std::string &amp;data, <span class="keywordtype">int</span> protocol);
<a name="l00073"></a>00073         PointerContext &amp;getPointerContext();
<a name="l00074"></a>00074         
<a name="l00075"></a>00075         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00076"></a>00076         <span class="keywordtype">void</span> read(T &amp;t)
<a name="l00077"></a>00077         {
<a name="l00078"></a>00078             <span class="keywordflow">try</span>
<a name="l00079"></a>00079             {
<a name="l00080"></a>00080                 <span class="keywordflow">switch</span> (protocol) 
<a name="l00081"></a>00081                 {
<a name="l00082"></a>00082                 <span class="keywordflow">case</span> 1: iprotocol1 &gt;&gt; t; <span class="keywordflow">break</span>;
<a name="l00083"></a>00083                 <span class="keywordflow">case</span> 2: iprotocol2 &gt;&gt; t; <span class="keywordflow">break</span>;
<a name="l00084"></a>00084                 <span class="keywordflow">case</span> 3: iprotocol3 &gt;&gt; t; <span class="keywordflow">break</span>;
<a name="l00085"></a>00085                 <span class="keywordflow">case</span> 4: iprotocol4 &gt;&gt; t; <span class="keywordflow">break</span>;
<a name="l00086"></a>00086                 <span class="keywordflow">default</span>: RCF_ASSERT(0)(protocol);
<a name="l00087"></a>00087                 }
<a name="l00088"></a>00088             }
<a name="l00089"></a>00089             <span class="keywordflow">catch</span>(<span class="keyword">const</span> std::exception &amp;e)
<a name="l00090"></a>00090             {
<a name="l00091"></a>00091                 RCF_THROW(RCF::SerializationException, <span class="stringliteral">"Serialization error"</span>)(e);
<a name="l00092"></a>00092             }
<a name="l00093"></a>00093         }
<a name="l00094"></a>00094 
<a name="l00095"></a>00095     <span class="keyword">private</span>:
<a name="l00096"></a>00096 
<a name="l00097"></a>00097         <span class="keyword">friend</span> <span class="keyword">class</span> ClientStub; <span class="comment">// TODO</span>
<a name="l00098"></a>00098         <span class="keyword">friend</span> <span class="keyword">class</span> Session; <span class="comment">// TODO</span>
<a name="l00099"></a>00099 
<a name="l00100"></a>00100         <span class="keywordtype">void</span> bindProtocol();
<a name="l00101"></a>00101         <span class="keywordtype">void</span> unbindProtocol();
<a name="l00102"></a>00102 
<a name="l00103"></a>00103         <span class="keywordtype">int</span> protocol;
<a name="l00104"></a>00104         std::istringstream ibuffer;
<a name="l00105"></a>00105         Protocol&lt;1&gt;::In iprotocol1;
<a name="l00106"></a>00106         Protocol&lt;2&gt;::In iprotocol2;
<a name="l00107"></a>00107         Protocol&lt;3&gt;::In iprotocol3;
<a name="l00108"></a>00108         Protocol&lt;4&gt;::In iprotocol4;
<a name="l00109"></a>00109         PointerContext pointerContext;
<a name="l00110"></a>00110     };
<a name="l00111"></a>00111 
<a name="l00112"></a>00112     <span class="keyword">class </span>SerializationProtocolOut
<a name="l00113"></a>00113     {
<a name="l00114"></a>00114     <span class="keyword">public</span>:
<a name="l00115"></a>00115         SerializationProtocolOut();
<a name="l00116"></a>00116         <span class="keywordtype">void</span> setSerializationProtocol(<span class="keywordtype">int</span> protocol);
<a name="l00117"></a>00117         <span class="keywordtype">int</span> getSerializationProtocol();
<a name="l00118"></a>00118         std::string str();
<a name="l00119"></a>00119         <span class="keywordtype">void</span> reset(<span class="keywordtype">int</span> protocol = 0);
<a name="l00120"></a>00120 
<a name="l00121"></a>00121         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00122"></a>00122         <span class="keywordtype">void</span> write(<span class="keyword">const</span> T &amp;t)
<a name="l00123"></a>00123         {
<a name="l00124"></a>00124             <span class="keywordflow">try</span>
<a name="l00125"></a>00125             {
<a name="l00126"></a>00126                 <span class="keywordflow">switch</span> (protocol) 
<a name="l00127"></a>00127                 {
<a name="l00128"></a>00128                 <span class="keywordflow">case</span> 1: oprotocol1 &lt;&lt; t; <span class="keywordflow">break</span>;
<a name="l00129"></a>00129                 <span class="keywordflow">case</span> 2: oprotocol2 &lt;&lt; t; <span class="keywordflow">break</span>;
<a name="l00130"></a>00130                 <span class="keywordflow">case</span> 3: oprotocol3 &lt;&lt; t; <span class="keywordflow">break</span>;
<a name="l00131"></a>00131                 <span class="keywordflow">case</span> 4: oprotocol4 &lt;&lt; t; <span class="keywordflow">break</span>;
<a name="l00132"></a>00132                 <span class="keywordflow">default</span>: RCF_ASSERT(0)(protocol);
<a name="l00133"></a>00133                 }
<a name="l00134"></a>00134             }
<a name="l00135"></a>00135             <span class="keywordflow">catch</span>(<span class="keyword">const</span> std::exception &amp;e)
<a name="l00136"></a>00136             {
<a name="l00137"></a>00137                 RCF_THROW(RCF::SerializationException, <span class="stringliteral">"Serialization error"</span>)(e);
<a name="l00138"></a>00138             }
<a name="l00139"></a>00139         }
<a name="l00140"></a>00140         
<a name="l00141"></a>00141     <span class="keyword">private</span>:
<a name="l00142"></a>00142 
<a name="l00143"></a>00143         <span class="keyword">friend</span> <span class="keyword">class</span> ClientStub; <span class="comment">// TODO</span>
<a name="l00144"></a>00144         <span class="keyword">friend</span> <span class="keyword">class</span> Session; <span class="comment">// TODO</span>
<a name="l00145"></a>00145 
<a name="l00146"></a>00146         <span class="keywordtype">void</span> bindProtocol();
<a name="l00147"></a>00147         <span class="keywordtype">void</span> unbindProtocol();
<a name="l00148"></a>00148 
<a name="l00149"></a>00149         <span class="keywordtype">int</span> protocol;
<a name="l00150"></a>00150         std::ostringstream obuffer;
<a name="l00151"></a>00151         Protocol&lt;1&gt;::Out oprotocol1;
<a name="l00152"></a>00152         Protocol&lt;2&gt;::Out oprotocol2;
<a name="l00153"></a>00153         Protocol&lt;3&gt;::Out oprotocol3;
<a name="l00154"></a>00154         Protocol&lt;4&gt;::Out oprotocol4;
<a name="l00155"></a>00155     };
<a name="l00156"></a>00156 
<a name="l00157"></a>00157     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; SerializationProtocolOut &amp;operator&lt;&lt;(SerializationProtocolOut &amp;out, <span class="keyword">const</span> T &amp;t)
<a name="l00158"></a>00158     {
<a name="l00159"></a>00159         out.write(t);
<a name="l00160"></a>00160         <span class="keywordflow">return</span> out;
<a name="l00161"></a>00161     }
<a name="l00162"></a>00162 
<a name="l00163"></a>00163     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; SerializationProtocolIn &amp;operator&gt;&gt;(SerializationProtocolIn &amp;in, T &amp;t)
<a name="l00164"></a>00164     {
<a name="l00165"></a>00165         in.read(t);
<a name="l00166"></a>00166         <span class="keywordflow">return</span> in;
<a name="l00167"></a>00167     }
<a name="l00168"></a>00168 
<a name="l00169"></a>00169 } <span class="comment">// namespace RCF</span>
<a name="l00170"></a>00170 
<a name="l00171"></a>00171 <span class="preprocessor">#endif // ! INCLUDE_RCF_SERIALIZATIONPROTOCOL_HPP</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Sep 19 19:02:37 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