Click here to Skip to main content
15,897,704 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.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: SubscriptionService.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>SubscriptionService.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_SUBSCRIPTIONSERVICE_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDE_RCF_SUBSCRIPTIONSERVICE_HPP</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;map&gt;</span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &lt;memory&gt;</span>
<a name="l00014"></a>00014 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;utility&gt;</span>
<a name="l00016"></a>00016 
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;boost/noncopyable.hpp&gt;</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;RCF/GetInterfaceName.hpp&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;RCF/Service.hpp&gt;</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="keyword">namespace </span>RCF {
<a name="l00024"></a>00024 
<a name="l00025"></a>00025     <span class="keyword">class </span>RcfServer;
<a name="l00026"></a>00026     <span class="keyword">class </span>I_ClientTransport;
<a name="l00027"></a>00027     <span class="keyword">class </span>I_ServerTransport;
<a name="l00028"></a>00028     <span class="keyword">class </span>I_Endpoint;
<a name="l00029"></a>00029     <span class="keyword">class </span>I_RcfClient;
<a name="l00030"></a>00030     <span class="keyword">typedef</span> boost::shared_ptr&lt;I_RcfClient&gt; RcfClientPtr;
<a name="l00031"></a>00031     <span class="keyword">typedef</span> std::auto_ptr&lt;I_ClientTransport&gt; ClientTransportAutoPtr;
<a name="l00032"></a>00032 
<a name="l00033"></a>00033     <span class="keyword">struct </span>SubscriptionStatus
<a name="l00034"></a>00034     {
<a name="l00035"></a>00035     };
<a name="l00036"></a>00036 
<a name="l00038"></a><a class="code" href="class_r_c_f_1_1_subscription_service.html">00038</a>     <span class="keyword">class </span><a class="code" href="class_r_c_f_1_1_subscription_service.html">SubscriptionService</a> : 
<a name="l00039"></a>00039         <span class="keyword">public</span> <a class="code" href="class_r_c_f_1_1_i___service.html">I_Service</a>, 
<a name="l00040"></a>00040         boost::noncopyable
<a name="l00041"></a>00041     {
<a name="l00042"></a>00042     <span class="keyword">public</span>:
<a name="l00043"></a>00043         <a class="code" href="class_r_c_f_1_1_subscription_service.html">SubscriptionService</a>();
<a name="l00044"></a>00044 
<a name="l00051"></a>00051         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Interface, <span class="keyword">typename</span> Object&gt;
<a name="l00052"></a>00052         <span class="keywordtype">bool</span> <a class="code" href="class_r_c_f_1_1_subscription_service.html#c4a57a40855dceeac36371e0edbd8f55">beginSubscribe</a>(Object &amp;object, <span class="keyword">const</span> <a class="code" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a> &amp;publisherEndpoint, <span class="keyword">const</span> std::string &amp;publisherName = <span class="stringliteral">""</span>);
<a name="l00053"></a>00053 
<a name="l00060"></a>00060         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Interface, <span class="keyword">typename</span> Object&gt;
<a name="l00061"></a>00061         <span class="keywordtype">bool</span> <a class="code" href="class_r_c_f_1_1_subscription_service.html#c4a57a40855dceeac36371e0edbd8f55">beginSubscribe</a>(Object &amp;object, ClientTransportAutoPtr clientTransportAutoPtr, <span class="keyword">const</span> std::string &amp;publisherName = <span class="stringliteral">""</span>);
<a name="l00062"></a>00062         
<a name="l00067"></a>00067         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Interface, <span class="keyword">typename</span> Object&gt;
<a name="l00068"></a><a class="code" href="class_r_c_f_1_1_subscription_service.html#395b7b656b0f48841b537f0cd9dd421d">00068</a>         <span class="keywordtype">bool</span> <a class="code" href="class_r_c_f_1_1_subscription_service.html#395b7b656b0f48841b537f0cd9dd421d">endSubscribe</a>(Object &amp;object)
<a name="l00069"></a>00069         {
<a name="l00070"></a>00070             SubscriptionId whichSubscription = getSubscriptionId&lt;Interface&gt;(object);
<a name="l00071"></a>00071             <span class="keywordflow">return</span> endSubscribeNamed(whichSubscription);
<a name="l00072"></a>00072         }
<a name="l00073"></a>00073 
<a name="l00079"></a>00079         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Interface, <span class="keyword">typename</span> Object&gt;
<a name="l00080"></a><a class="code" href="class_r_c_f_1_1_subscription_service.html#8a242f7e5ca78bf240ddc20e30df5735">00080</a>         SubscriptionStatus <a class="code" href="class_r_c_f_1_1_subscription_service.html#8a242f7e5ca78bf240ddc20e30df5735">getSubscriptionStatus</a>(Object &amp;object)
<a name="l00081"></a>00081         {
<a name="l00082"></a>00082             SubscriptionId whichSubscription = getSubscriptionId&lt;Interface&gt;(object);
<a name="l00083"></a>00083             <span class="keywordflow">return</span> getSubscriptionStatusNamed(whichSubscription);
<a name="l00084"></a>00084         }
<a name="l00085"></a>00085 
<a name="l00086"></a>00086     <span class="keyword">private</span>:
<a name="l00087"></a>00087 
<a name="l00088"></a>00088         <span class="keywordtype">void</span> onServiceAdded(<a class="code" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;server);
<a name="l00089"></a>00089         <span class="keywordtype">void</span> onServiceRemoved(<a class="code" href="class_r_c_f_1_1_rcf_server.html">RcfServer</a> &amp;server);
<a name="l00090"></a>00090 
<a name="l00091"></a>00091         <span class="keyword">typedef</span> std::pair&lt;std::string, void *&gt; ObjectId; <span class="comment">// ObjectId = (typename, address)</span>
<a name="l00092"></a>00092         <span class="keyword">typedef</span> std::pair&lt;std::string, ObjectId&gt; SubscriptionId;
<a name="l00093"></a>00093 
<a name="l00094"></a>00094         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Object&gt;
<a name="l00095"></a>00095         ObjectId getObjectId(Object &amp;object)
<a name="l00096"></a>00096         {
<a name="l00097"></a>00097             <span class="keywordflow">return</span> std::make_pair( <span class="keyword">typeid</span>(Object).name(), &amp;object );
<a name="l00098"></a>00098         }
<a name="l00099"></a>00099 
<a name="l00100"></a>00100         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Interface, <span class="keyword">typename</span> Object&gt;
<a name="l00101"></a>00101         SubscriptionId getSubscriptionId(Object &amp;object)
<a name="l00102"></a>00102         {
<a name="l00103"></a>00103             <span class="keywordflow">return</span> std::make_pair(::RCF::getInterfaceName&lt;Interface&gt;(), getObjectId(object));
<a name="l00104"></a>00104         }
<a name="l00105"></a>00105 
<a name="l00106"></a>00106         <span class="keywordtype">bool</span> beginSubscribeNamed(SubscriptionId whichSubscription, RcfClientPtr rcfClientPtr, ClientTransportAutoPtr publisherClientTransportPtr, <span class="keyword">const</span> std::string &amp;publisherName);
<a name="l00107"></a>00107         <span class="keywordtype">bool</span> beginSubscribeNamed(SubscriptionId whichSubscription, RcfClientPtr rcfClientPtr, <span class="keyword">const</span> I_Endpoint &amp;publisherEndpoint, <span class="keyword">const</span> std::string &amp;publisherName);
<a name="l00108"></a>00108         <span class="keywordtype">bool</span> endSubscribeNamed(SubscriptionId whichSubscription);
<a name="l00109"></a>00109         SubscriptionStatus getSubscriptionStatusNamed(SubscriptionId whichSubscription);
<a name="l00110"></a>00110 
<a name="l00111"></a>00111         boost::shared_ptr&lt;I_ServerTransport&gt; mServerTransportPtr;
<a name="l00112"></a>00112 
<a name="l00113"></a>00113         <span class="keyword">struct </span>Subscription : boost::noncopyable
<a name="l00114"></a>00114         {
<a name="l00115"></a>00115             Subscription(SubscriptionId <span class="keywordtype">id</span>, std::auto_ptr&lt;I_ClientTransport&gt; clientTransport);
<a name="l00116"></a>00116             ~Subscription();
<a name="l00117"></a>00117             SubscriptionId id;
<a name="l00118"></a>00118             std::auto_ptr&lt;I_ClientTransport&gt; clientTransport;
<a name="l00119"></a>00119             SubscriptionStatus status;
<a name="l00120"></a>00120         };
<a name="l00121"></a>00121 
<a name="l00122"></a>00122         ReadWriteMutex mSubscriptionsMutex;
<a name="l00123"></a>00123         std::map&lt;SubscriptionId, boost::shared_ptr&lt;Subscription&gt; &gt; mSubscriptions;
<a name="l00124"></a>00124     };
<a name="l00125"></a>00125 
<a name="l00126"></a>00126     <span class="keyword">typedef</span> boost::shared_ptr&lt;SubscriptionService&gt; SubscriptionServicePtr;
<a name="l00127"></a>00127 
<a name="l00128"></a>00128     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Interface, <span class="keyword">typename</span> Object&gt;
<a name="l00129"></a><a class="code" href="class_r_c_f_1_1_subscription_service.html#c4a57a40855dceeac36371e0edbd8f55">00129</a>     <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_r_c_f_1_1_subscription_service.html#c4a57a40855dceeac36371e0edbd8f55">SubscriptionService::beginSubscribe</a>(Object &amp;object, <span class="keyword">const</span> <a class="code" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a> &amp;publisherEndpoint, <span class="keyword">const</span> std::string &amp;publisherName_)
<a name="l00130"></a>00130     {
<a name="l00131"></a>00131         <span class="keyword">const</span> std::string &amp;publisherName = (publisherName_ == <span class="stringliteral">""</span>) ? getInterfaceName&lt;Interface&gt;() : publisherName_;
<a name="l00132"></a>00132         SubscriptionId whichSubscription = getSubscriptionId&lt;Interface&gt;(object);
<a name="l00133"></a>00133         boost::shared_ptr&lt; I_Deref&lt;Object&gt; &gt; derefPtr( <span class="keyword">new</span> DerefObj&lt;Object&gt;(object) );
<a name="l00134"></a>00134         RcfClientPtr rcfClientPtr( RCF_createServerStub((Interface *) 0, (Object *) 0, derefPtr) );
<a name="l00135"></a>00135         <span class="keywordflow">return</span> beginSubscribeNamed(whichSubscription, rcfClientPtr, publisherEndpoint, publisherName);
<a name="l00136"></a>00136     }
<a name="l00137"></a>00137 
<a name="l00138"></a>00138     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Interface, <span class="keyword">typename</span> Object&gt;
<a name="l00139"></a><a class="code" href="class_r_c_f_1_1_subscription_service.html#febb04043295d0f9e469cae767c5aa3a">00139</a>     <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_r_c_f_1_1_subscription_service.html#c4a57a40855dceeac36371e0edbd8f55">SubscriptionService::beginSubscribe</a>(Object &amp;object, ClientTransportAutoPtr clientTransportAutoPtr, <span class="keyword">const</span> std::string &amp;publisherName_)
<a name="l00140"></a>00140     {
<a name="l00141"></a>00141         <span class="keyword">const</span> std::string &amp;publisherName = (publisherName_ == <span class="stringliteral">""</span>) ? getInterfaceName&lt;Interface&gt;() : publisherName_;
<a name="l00142"></a>00142         SubscriptionId whichSubscription = getSubscriptionId&lt;Interface&gt;(object);
<a name="l00143"></a>00143         boost::shared_ptr&lt; I_Deref&lt;Object&gt; &gt; derefPtr( <span class="keyword">new</span> DerefObj&lt;Object&gt;(object) );
<a name="l00144"></a>00144         RcfClientPtr rcfClientPtr( RCF_createServerStub((Interface *) 0, (Object *) 0, derefPtr) );
<a name="l00145"></a>00145         <span class="keywordflow">return</span> beginSubscribeNamed(whichSubscription, rcfClientPtr, clientTransportAutoPtr, publisherName);
<a name="l00146"></a>00146     }
<a name="l00147"></a>00147 
<a name="l00148"></a>00148 
<a name="l00149"></a>00149 } <span class="comment">// namespace RCF</span>
<a name="l00150"></a>00150 
<a name="l00151"></a>00151 <span class="preprocessor">#endif // ! INCLUDE_RCF_SUBSCRIPTIONSERVICE_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