Click here to Skip to main content
15,892,768 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: ObjectFactoryService.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>ObjectFactoryService.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_OBJECTFACTORYSERVICE_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDE_RCF_OBJECTFACTORYSERVICE_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;string&gt;</span>
<a name="l00014"></a>00014 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00015"></a>00015 
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;boost/utility.hpp&gt;</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;RCF/GetInterfaceName.hpp&gt;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;RCF/Service.hpp&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;RCF/StubFactory.hpp&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;RCF/ThreadLibrary.hpp&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;RCF/Token.hpp&gt;</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="keyword">namespace </span>RCF {
<a name="l00026"></a>00026 
<a name="l00027"></a>00027     <span class="keyword">class </span>RcfServer;
<a name="l00028"></a>00028     <span class="keyword">class </span>StubEntry;
<a name="l00029"></a>00029     <span class="keyword">class </span>I_StubFactory;
<a name="l00030"></a>00030     <span class="keyword">class </span>I_RcfClient;
<a name="l00031"></a>00031     <span class="keyword">class </span>Token;
<a name="l00032"></a>00032 
<a name="l00033"></a>00033     <span class="keyword">typedef</span> boost::shared_ptr&lt;StubEntry&gt; StubEntryPtr;
<a name="l00034"></a>00034     <span class="keyword">typedef</span> boost::shared_ptr&lt;I_StubFactory&gt; StubFactoryPtr;
<a name="l00035"></a>00035 
<a name="l00038"></a><a class="code" href="class_r_c_f_1_1_object_factory_service.html">00038</a>     <span class="keyword">class </span><a class="code" href="class_r_c_f_1_1_object_factory_service.html">ObjectFactoryService</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         <span class="keyword">public</span> I_StubEntryLookupProvider,
<a name="l00041"></a>00041         boost::noncopyable
<a name="l00042"></a>00042     {
<a name="l00043"></a>00043     <span class="keyword">public</span>:
<a name="l00044"></a>00044 
<a name="l00048"></a>00048         <a class="code" href="class_r_c_f_1_1_object_factory_service.html#2884e30e431e831e45b6f13f1f1ff36f">ObjectFactoryService</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numberOfTokens, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> objectTimeoutS);
<a name="l00049"></a>00049 
<a name="l00054"></a>00054         <span class="keywordtype">bool</span> <a class="code" href="class_r_c_f_1_1_object_factory_service.html#d62769aca8a45cd37dbc922db5c55fe5">createObject</a>(<span class="keyword">const</span> std::string &amp;objectName, Token &amp;token);
<a name="l00055"></a>00055 
<a name="l00059"></a>00059         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> InterfaceT, <span class="keyword">typename</span> ImplementationT&gt; 
<a name="l00060"></a>00060         <span class="keywordtype">bool</span> <a class="code" href="class_r_c_f_1_1_object_factory_service.html#c95bcd8e321d39a6b3442a4f652f6960">bind</a>(std::string name = <span class="stringliteral">""</span>);
<a name="l00061"></a>00061 
<a name="l00062"></a>00062     <span class="keyword">private</span>:
<a name="l00063"></a>00063         StubEntryPtr getStubEntryPtr(<span class="keyword">const</span> Token &amp;token);
<a name="l00064"></a>00064         <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="l00065"></a>00065         <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="l00066"></a>00066         <span class="comment">//void wakeCleanup();</span>
<a name="l00067"></a>00067         <span class="keywordtype">void</span> stopCleanup();
<a name="l00068"></a>00068         <span class="keywordtype">bool</span> cycleCleanup(<span class="keywordtype">int</span> timeoutMs, <span class="keyword">const</span> <span class="keyword">volatile</span> <span class="keywordtype">bool</span> &amp;stopFlag);
<a name="l00069"></a>00069         <span class="keywordtype">bool</span> insertStubFactory(<span class="keyword">const</span> std::string &amp;objectName, <span class="keyword">const</span> std::string &amp;desc, boost::shared_ptr&lt;I_StubFactory&gt; factory);
<a name="l00070"></a>00070         <span class="keywordtype">bool</span> removeStubFactory(<span class="keyword">const</span> std::string &amp;objectName);
<a name="l00071"></a>00071         boost::shared_ptr&lt;I_StubFactory&gt; getStubFactory(<span class="keyword">const</span> std::string &amp;objectName);
<a name="l00072"></a>00072         <span class="keywordtype">void</span> cleanupStubMap(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeoutS);
<a name="l00073"></a>00073         <span class="keywordtype">void</span> allocateStubMap();
<a name="l00074"></a>00074 
<a name="l00075"></a>00075         <span class="keyword">class </span>TokenFactory : boost::noncopyable
<a name="l00076"></a>00076         {
<a name="l00077"></a>00077         <span class="keyword">public</span>:
<a name="l00078"></a>00078             TokenFactory(<span class="keywordtype">int</span> tokenCount);
<a name="l00079"></a>00079             <span class="keywordtype">bool</span> requestToken(Token &amp;token);
<a name="l00080"></a>00080             <span class="keywordtype">void</span> returnToken(<span class="keyword">const</span> Token &amp;token);
<a name="l00081"></a>00081             <span class="keyword">const</span> std::vector&lt;Token&gt; &amp;getTokenSpace();
<a name="l00082"></a>00082             <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getAvailableTokenCount();
<a name="l00083"></a>00083 
<a name="l00084"></a>00084         <span class="keyword">private</span>:
<a name="l00085"></a>00085             std::vector&lt;Token&gt; mTokenSpace;
<a name="l00086"></a>00086             std::vector&lt;Token&gt; mAvailableTokens;
<a name="l00087"></a>00087             ReadWriteMutex mMutex;
<a name="l00088"></a>00088         };
<a name="l00089"></a>00089 
<a name="l00090"></a>00090         <span class="comment">// internally synchronized</span>
<a name="l00091"></a>00091         TokenFactory mTokenFactory;
<a name="l00092"></a>00092 
<a name="l00093"></a>00093         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mClientStubTimeoutS;
<a name="l00094"></a>00094         Mutex mCleanupThresholdMutex;
<a name="l00095"></a>00095         Condition mCleanupThresholdCondition;
<a name="l00096"></a>00096         
<a name="l00097"></a>00097         <span class="keyword">typedef</span> std::map&lt;std::string, StubFactoryPtr&gt; StubFactoryMap;
<a name="l00098"></a>00098         <span class="keyword">typedef</span> std::map&lt;Token, StubEntryPtr&gt; StubMap;
<a name="l00099"></a>00099         StubMap mStubMap; <span class="comment">// preallocated and synchronized per element</span>
<a name="l00100"></a>00100 
<a name="l00101"></a>00101         ReadWriteMutex mStubFactoryMapMutex;
<a name="l00102"></a>00102         StubFactoryMap mStubFactoryMap;
<a name="l00103"></a>00103 
<a name="l00104"></a>00104         <span class="keyword">volatile</span> <span class="keywordtype">bool</span> mStopFlag;
<a name="l00105"></a>00105     };
<a name="l00106"></a>00106 
<a name="l00107"></a>00107     <span class="keyword">typedef</span> boost::shared_ptr&lt;ObjectFactoryService&gt; ObjectFactoryServicePtr;
<a name="l00108"></a>00108 
<a name="l00109"></a>00109     <span class="keywordtype">bool</span> createRemoteObjectNamed(<a class="code" href="class_r_c_f_1_1_i___rcf_client.html">I_RcfClient</a> &amp;rcfClient, std::string objectName);
<a name="l00110"></a>00110 
<a name="l00111"></a>00111     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Interface&gt;
<a name="l00112"></a>00112     <span class="keyword">inline</span> <span class="keywordtype">bool</span> createRemoteObject(<a class="code" href="class_r_c_f_1_1_i___rcf_client.html">I_RcfClient</a> &amp;rcfClient, std::string objectName = <span class="stringliteral">""</span>)
<a name="l00113"></a>00113     {
<a name="l00114"></a>00114         <span class="keywordflow">if</span> (objectName == <span class="stringliteral">""</span>)
<a name="l00115"></a>00115         {
<a name="l00116"></a>00116             objectName = getInterfaceName&lt;Interface&gt;();
<a name="l00117"></a>00117         }
<a name="l00118"></a>00118         <span class="keywordflow">return</span> createRemoteObjectNamed(rcfClient, objectName);
<a name="l00119"></a>00119     }
<a name="l00120"></a>00120 
<a name="l00121"></a>00121     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> InterfaceT, <span class="keyword">typename</span> ImplementationT&gt; 
<a name="l00122"></a><a class="code" href="class_r_c_f_1_1_object_factory_service.html#c95bcd8e321d39a6b3442a4f652f6960">00122</a>     <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_r_c_f_1_1_object_factory_service.html#c95bcd8e321d39a6b3442a4f652f6960">ObjectFactoryService::bind</a>(std::string name_)
<a name="l00123"></a>00123     {
<a name="l00124"></a>00124         <span class="keyword">const</span> std::string &amp;name = (name_ == <span class="stringliteral">""</span>) ? getInterfaceName&lt;InterfaceT&gt;() : name_;
<a name="l00125"></a>00125         boost::shared_ptr&lt;I_StubFactory&gt; stubFactoryPtr( <span class="keyword">new</span> RCF::StubFactory&lt;ImplementationT, InterfaceT&gt;() );
<a name="l00126"></a>00126         std::string desc; <span class="comment">// TODO</span>
<a name="l00127"></a>00127         <span class="keywordflow">return</span> insertStubFactory(name, desc, stubFactoryPtr);
<a name="l00128"></a>00128     }
<a name="l00129"></a>00129 
<a name="l00130"></a>00130 } <span class="comment">// namespace RCF</span>
<a name="l00131"></a>00131 
<a name="l00132"></a>00132 <span class="preprocessor">#endif // ! INCLUDE_RCF_OBJECTFACTORYSERVICE_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
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

Web04 2.8:2024-04-02:1