Click here to Skip to main content
15,880,427 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: TcpAsioSynchronizedSocket.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>TcpAsioSynchronizedSocket.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_TCPASIOSYNCHRONIZEDSOCKET_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDE_RCF_TCPASIOSYNCHRONIZEDSOCKET_HPP</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;boost/asio.hpp&gt;</span>
<a name="l00013"></a>00013 
<a name="l00014"></a>00014 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
<a name="l00015"></a>00015 
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;RCF/ThreadLibrary.hpp&gt;</span>
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 <span class="keyword">namespace </span>RCF {
<a name="l00019"></a>00019     <span class="keyword">namespace </span>asio = boost::asio;
<a name="l00020"></a>00020 
<a name="l00021"></a>00021     <span class="keyword">typedef</span> asio::io_service Demuxer;
<a name="l00022"></a>00022     <span class="keyword">typedef</span> boost::shared_ptr&lt;Demuxer&gt; DemuxerPtr;
<a name="l00023"></a>00023     <span class="keyword">typedef</span> boost::shared_ptr&lt;ReadWriteMutex&gt; ReadWriteMutexPtr;
<a name="l00024"></a>00024     <span class="keyword">typedef</span> std::auto_ptr&lt;Mutex&gt; MutexAutoPtr;
<a name="l00025"></a>00025 
<a name="l00026"></a>00026     <span class="keyword">class </span>TcpAsioSynchronizedSocket
<a name="l00027"></a>00027     {
<a name="l00028"></a>00028     <span class="keyword">public</span>:
<a name="l00029"></a>00029         TcpAsioSynchronizedSocket(DemuxerPtr demuxerPtr, ReadWriteMutexPtr readWriteMutexPtr = ReadWriteMutexPtr());
<a name="l00030"></a>00030         
<a name="l00031"></a>00031         <span class="comment">// async functions</span>
<a name="l00032"></a>00032         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00033"></a>00033         <span class="keywordtype">void</span> connect(<span class="keyword">const</span> asio::ip::tcp::endpoint &amp;endpoint, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00034"></a>00034 
<a name="l00035"></a>00035         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00036"></a>00036         <span class="keywordtype">void</span> accept(asio::ip::tcp::acceptor &amp;acceptor, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00037"></a>00037 
<a name="l00038"></a>00038         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00039"></a>00039         <span class="keywordtype">void</span> read(<span class="keywordtype">char</span> *buffer, std::size_t bufferLen, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00040"></a>00040 
<a name="l00041"></a>00041         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00042"></a>00042         <span class="keywordtype">void</span> write(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, std::size_t bufferLen, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00043"></a>00043 
<a name="l00044"></a>00044         <span class="comment">// sync functions</span>
<a name="l00045"></a>00045         std::size_t read(<span class="keywordtype">char</span> *buffer, std::size_t bufferLen, asio::error &amp;error);
<a name="l00046"></a>00046         std::size_t write(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, std::size_t bufferLen, asio::error &amp;error);
<a name="l00047"></a>00047         <span class="keywordtype">void</span> open();
<a name="l00048"></a>00048         <span class="keywordtype">void</span> close();
<a name="l00049"></a>00049         <span class="keywordtype">void</span> getRemoteEndpoint(asio::ip::tcp::endpoint &amp;endpoint) <span class="keyword">const</span>;
<a name="l00050"></a>00050         <span class="keywordtype">void</span> setSynchronized(<span class="keywordtype">bool</span> <span class="keyword">synchronized</span>);
<a name="l00051"></a>00051         <span class="keywordtype">void</span> setCloseFlag();
<a name="l00052"></a>00052         <span class="keywordtype">bool</span> getCloseFlag();
<a name="l00053"></a>00053         <span class="keywordtype">bool</span> isConnected();
<a name="l00054"></a>00054         asio::ip::tcp::socket::native_type impl();
<a name="l00055"></a>00055 
<a name="l00056"></a>00056     <span class="keyword">private</span>:
<a name="l00057"></a>00057         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00058"></a>00058         <span class="keywordtype">void</span> connectSynchronized(<span class="keyword">const</span> asio::ip::tcp::endpoint &amp;endpoint, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00059"></a>00059 
<a name="l00060"></a>00060         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00061"></a>00061         <span class="keywordtype">void</span> connectUnsynchronized(<span class="keyword">const</span> asio::ip::tcp::endpoint &amp;endpoint, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00062"></a>00062 
<a name="l00063"></a>00063         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00064"></a>00064         <span class="keywordtype">void</span> acceptSynchronized(asio::ip::tcp::acceptor &amp;acceptor, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00067"></a>00067         <span class="keywordtype">void</span> acceptUnsynchronized(asio::ip::tcp::acceptor &amp;acceptor, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00068"></a>00068 
<a name="l00069"></a>00069         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00070"></a>00070         <span class="keywordtype">void</span> readSynchronized(<span class="keywordtype">char</span> *buffer, std::size_t bufferLen, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00071"></a>00071 
<a name="l00072"></a>00072         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00073"></a>00073         <span class="keywordtype">void</span> readUnsynchronized(<span class="keywordtype">char</span> *buffer, std::size_t bufferLen, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00074"></a>00074 
<a name="l00075"></a>00075         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00076"></a>00076         <span class="keywordtype">void</span> writeSynchronized(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, std::size_t bufferLen, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00077"></a>00077         
<a name="l00078"></a>00078         <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;
<a name="l00079"></a>00079         <span class="keywordtype">void</span> writeUnsynchronized(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, std::size_t bufferLen, <span class="keyword">const</span> Handler &amp;handler);
<a name="l00080"></a>00080 
<a name="l00081"></a>00081         <span class="keywordtype">void</span> onError(asio::error &amp;myError, <span class="keyword">const</span> asio::error &amp;error);
<a name="l00082"></a>00082         <span class="keywordtype">bool</span> isConnectedSynchronized();
<a name="l00083"></a>00083         <span class="keywordtype">bool</span> isConnectedUnsynchronized();
<a name="l00084"></a>00084         std::size_t writeSynchronized(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, std::size_t bufferLen, asio::error &amp;error);
<a name="l00085"></a>00085         std::size_t writeUnsynchronized(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, std::size_t bufferLen, asio::error &amp;error);
<a name="l00086"></a>00086         std::size_t readSynchronized(<span class="keywordtype">char</span> *buffer, std::size_t bufferLen, asio::error &amp;error);
<a name="l00087"></a>00087         std::size_t readUnsynchronized(<span class="keywordtype">char</span> *buffer, std::size_t bufferLen, asio::error &amp;error);
<a name="l00088"></a>00088         <span class="keywordtype">void</span> openSynchronized();
<a name="l00089"></a>00089         <span class="keywordtype">void</span> openUnsynchronized();
<a name="l00090"></a>00090         <span class="keywordtype">void</span> closeSynchronized();
<a name="l00091"></a>00091         <span class="keywordtype">void</span> closeUnsynchronized();
<a name="l00092"></a>00092         <span class="keywordtype">void</span> getRemoteEndpointSynchronized(asio::ip::tcp::endpoint &amp;endpoint) <span class="keyword">const</span>;
<a name="l00093"></a>00093         <span class="keywordtype">void</span> getRemoteEndpointUnsynchronized(asio::ip::tcp::endpoint &amp;endpoint) <span class="keyword">const</span>;
<a name="l00094"></a>00094         asio::ip::tcp::socket::native_type implSynchronized();
<a name="l00095"></a>00095         asio::ip::tcp::socket::native_type implUnsynchronized();
<a name="l00096"></a>00096 
<a name="l00097"></a>00097     <span class="keyword">private</span>:
<a name="l00098"></a>00098         ReadWriteMutexPtr           mReadWriteMutexPtr;
<a name="l00099"></a>00099         MutexAutoPtr                mMutexAutoPtr;
<a name="l00100"></a>00100         <span class="comment">//DemuxerPtr                  mDemuxerPtr;</span>
<a name="l00101"></a>00101         asio::ip::tcp::socket         mSocket;
<a name="l00102"></a>00102         <span class="keyword">volatile</span> <span class="keywordtype">bool</span>               mCloseFlag;
<a name="l00103"></a>00103     };
<a name="l00104"></a>00104 
<a name="l00105"></a>00105 } <span class="comment">// namespace RCF</span>
<a name="l00106"></a>00106 
<a name="l00107"></a>00107 <span class="preprocessor">#endif // ! INCLUDE_RCF_TCPASIOSYNCHRONIZEDSOCKET_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