Click here to Skip to main content
15,891,423 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: TcpClientTransport.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>TcpClientTransport.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_TCPCLIENTTRANSPORT_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDE_RCF_TCPCLIENTTRANSPORT_HPP</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;utility&gt;</span> <span class="comment">// std::make_pair</span>
<a name="l00013"></a>00013 
<a name="l00014"></a>00014 <span class="preprocessor">#include &lt;RCF/AsyncFilter.hpp&gt;</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;RCF/ByteOrdering.hpp&gt;</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;RCF/ClientTransport.hpp&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;RCF/UsingBsdSockets.hpp&gt;</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="keyword">namespace </span>RCF {
<a name="l00020"></a>00020 
<a name="l00021"></a>00021     <span class="comment">//******************************************************</span>
<a name="l00022"></a>00022     <span class="comment">// nonblocking socket routines</span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024     <span class="keywordtype">int</span> timedConnect(<span class="keywordtype">int</span> timeoutMs, <span class="keywordtype">int</span> fd, sockaddr *addr, <span class="keywordtype">int</span> size);
<a name="l00025"></a>00025     
<a name="l00026"></a>00026     <span class="comment">// returns -2 for timeout, -1 for error, otherwise number of bytes sent (&gt; 0)</span>
<a name="l00027"></a>00027     <span class="keywordtype">int</span> timedSend(<span class="keywordtype">int</span> timeoutMs, <span class="keywordtype">int</span> fd, <span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, std::size_t length, <span class="keywordtype">int</span> flags);
<a name="l00028"></a>00028 
<a name="l00029"></a>00029     <span class="comment">// returns -2 for timeout, -1 for error, 0 for peer closure, otherwise size of packet read</span>
<a name="l00030"></a>00030     <span class="keyword">inline</span> <span class="keywordtype">int</span> timedRecv(<span class="keywordtype">int</span> timeoutMs, <span class="keywordtype">int</span> fd, <span class="keywordtype">char</span> *buffer, std::size_t bufferLen, <span class="keywordtype">int</span> flags);
<a name="l00031"></a>00031     
<a name="l00032"></a>00032     <span class="keyword">class </span>BsdRecvFunctor
<a name="l00033"></a>00033     {
<a name="l00034"></a>00034     <span class="keyword">public</span>:
<a name="l00035"></a>00035         BsdRecvFunctor();
<a name="l00036"></a>00036 
<a name="l00037"></a>00037         <span class="keyword">enum</span> Status
<a name="l00038"></a>00038         {
<a name="l00039"></a>00039             Ok,
<a name="l00040"></a>00040             ConnectionReset,
<a name="l00041"></a>00041             SocketError,
<a name="l00042"></a>00042             TimeOut
<a name="l00043"></a>00043         };
<a name="l00044"></a>00044 
<a name="l00045"></a>00045         <span class="keywordtype">void</span> setFd(<span class="keywordtype">int</span> fd);
<a name="l00046"></a>00046         <span class="keywordtype">int</span> getFd();
<a name="l00047"></a>00047         <span class="keywordtype">void</span> setEndTimeMs(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> endTimeMs);
<a name="l00048"></a>00048         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getEndTimeMs();
<a name="l00049"></a>00049         Status getStatus();
<a name="l00050"></a>00050         <span class="keywordtype">void</span> operator()(<span class="keywordtype">char</span> *buffer, std::size_t bufferLen);
<a name="l00051"></a>00051         Filter::ReadFunction getReadFunction();
<a name="l00052"></a>00052         <span class="keywordtype">void</span> setReadWriteCompletionCallback(Filter::ReadWriteCompletionCallback readWriteCompletionCallback);
<a name="l00053"></a>00053 
<a name="l00054"></a>00054     <span class="keyword">private</span>:
<a name="l00055"></a>00055         Filter::ReadWriteCompletionCallback readWriteCompletionCallback;
<a name="l00056"></a>00056         <span class="keywordtype">int</span> fd;
<a name="l00057"></a>00057         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> endTimeMs;
<a name="l00058"></a>00058         Status status;
<a name="l00059"></a>00059     };
<a name="l00060"></a>00060 
<a name="l00061"></a>00061     <span class="keyword">class </span>BsdSendFunctor
<a name="l00062"></a>00062     {
<a name="l00063"></a>00063     <span class="keyword">public</span>:
<a name="l00064"></a>00064         BsdSendFunctor();
<a name="l00065"></a>00065 
<a name="l00066"></a>00066         <span class="keyword">enum</span> Status
<a name="l00067"></a>00067         {
<a name="l00068"></a>00068             Ok,
<a name="l00069"></a>00069             SocketError,
<a name="l00070"></a>00070             TimeOut
<a name="l00071"></a>00071         };
<a name="l00072"></a>00072 
<a name="l00073"></a>00073         <span class="keywordtype">void</span> setFd(<span class="keywordtype">int</span> fd);
<a name="l00074"></a>00074         <span class="keywordtype">int</span> getFd();
<a name="l00075"></a>00075         <span class="keywordtype">void</span> setEndTimeMs(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> endTimeMs);
<a name="l00076"></a>00076         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getEndTimeMs();
<a name="l00077"></a>00077         <span class="keywordtype">void</span> operator()(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, std::size_t bufferLen);
<a name="l00078"></a>00078         Filter::WriteFunction getWriteFunction();
<a name="l00079"></a>00079         <span class="keywordtype">void</span> setReadWriteCompletionCallback(Filter::ReadWriteCompletionCallback readWriteCompletionCallback);
<a name="l00080"></a>00080 
<a name="l00081"></a>00081     <span class="keyword">private</span>:
<a name="l00082"></a>00082 
<a name="l00083"></a>00083         Filter::ReadWriteCompletionCallback readWriteCompletionCallback;
<a name="l00084"></a>00084         <span class="keywordtype">int</span> fd;
<a name="l00085"></a>00085         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> endTimeMs;
<a name="l00086"></a>00086         Status status;
<a name="l00087"></a>00087     };
<a name="l00088"></a>00088     
<a name="l00089"></a>00089     <span class="keyword">class </span>TcpClientTransport;
<a name="l00090"></a>00090 
<a name="l00091"></a>00091     <span class="keyword">typedef</span> boost::shared_ptr&lt;TcpClientTransport&gt; TcpClientTransportPtr;
<a name="l00092"></a>00092 
<a name="l00093"></a>00093     <span class="keyword">class </span>TcpClientTransport : <span class="keyword">public</span> I_ClientTransport
<a name="l00094"></a>00094     {
<a name="l00095"></a>00095     <span class="keyword">public</span>:
<a name="l00096"></a>00096         TcpClientTransport::TcpClientTransport(<span class="keyword">const</span> TcpClientTransport &amp;rhs);
<a name="l00097"></a>00097         TcpClientTransport(<span class="keyword">const</span> std::string &amp;ip, <span class="keywordtype">int</span> port);
<a name="l00098"></a>00098         TcpClientTransport(sockaddr_in remoteAddr);
<a name="l00099"></a>00099         TcpClientTransport(<span class="keywordtype">int</span> fd);
<a name="l00100"></a>00100         ~TcpClientTransport();
<a name="l00101"></a>00101         std::auto_ptr&lt;I_ClientTransport&gt; clone() <span class="keyword">const</span>;
<a name="l00102"></a>00102         EndpointPtr getEndpointPtr() <span class="keyword">const</span>;
<a name="l00103"></a>00103         <span class="keywordtype">int</span> connect(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeoutMs);
<a name="l00104"></a>00104 
<a name="l00105"></a>00105         <span class="comment">// return -1 for error (including timeout), 1 for ok</span>
<a name="l00106"></a>00106         <span class="keywordtype">int</span> send(<span class="keyword">const</span> std::string &amp;data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeoutMs);
<a name="l00107"></a>00107 
<a name="l00108"></a>00108         <span class="comment">// return -1 for error (including timeout), otherwise bufferLen</span>
<a name="l00109"></a>00109         <span class="keywordtype">int</span> timedReceive(<span class="keywordtype">char</span> *buffer, std::size_t bufferLen);
<a name="l00110"></a>00110 
<a name="l00111"></a>00111         <span class="comment">// returns -2 for timeout, .1 for error, 0 for peer closure, 1 for ok</span>
<a name="l00112"></a>00112         <span class="keywordtype">int</span> receive(std::string &amp;data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeoutMs);
<a name="l00113"></a>00113         
<a name="l00114"></a>00114         <span class="keyword">typedef</span> boost::function1&lt;void, int &amp;&gt; CloseFunctor;
<a name="l00115"></a>00115 
<a name="l00116"></a>00116         <span class="keywordtype">void</span> setCloseFunctor(CloseFunctor closeFunctor);
<a name="l00117"></a>00117         <span class="keywordtype">void</span> setRemoteAddr(<span class="keyword">const</span> sockaddr_in &amp;remoteAddr);
<a name="l00118"></a>00118         <span class="keyword">const</span> sockaddr_in &amp;getRemoteAddr();
<a name="l00119"></a>00119         <span class="keywordtype">void</span> close();
<a name="l00120"></a>00120         <span class="keywordtype">bool</span> isConnected();
<a name="l00121"></a>00121         <span class="keywordtype">int</span> releaseFd();
<a name="l00122"></a>00122         <span class="keywordtype">int</span> getFd();
<a name="l00123"></a>00123         <span class="keywordtype">void</span> setTransportFilters(<span class="keyword">const</span> std::vector&lt;FilterPtr&gt; &amp;filters);
<a name="l00124"></a>00124         <span class="keywordtype">void</span> connectTransportFilters();
<a name="l00125"></a>00125         <span class="keywordtype">void</span> onReadWriteCompleted(std::size_t bytes, <span class="keywordtype">int</span> error);
<a name="l00126"></a>00126 
<a name="l00127"></a>00127     <span class="keyword">private</span>:
<a name="l00128"></a>00128         sockaddr_in mRemoteAddr;
<a name="l00129"></a>00129         std::string ip;
<a name="l00130"></a>00130         <span class="keywordtype">int</span> port;
<a name="l00131"></a>00131         <span class="keywordtype">int</span> fd;
<a name="l00132"></a>00132         <span class="keywordtype">bool</span> own;
<a name="l00133"></a>00133 
<a name="l00134"></a>00134         std::size_t mBytesTransferred;
<a name="l00135"></a>00135         <span class="keywordtype">int</span> mError;
<a name="l00136"></a>00136 
<a name="l00137"></a>00137         boost::shared_ptr&lt; CloseFunctor &gt; mCloseFunctor;
<a name="l00138"></a>00138         std::vector&lt;FilterPtr&gt; mTransportFilters;
<a name="l00139"></a>00139         BsdSendFunctor sendFunctor;
<a name="l00140"></a>00140         BsdRecvFunctor recvFunctor;
<a name="l00141"></a>00141     };
<a name="l00142"></a>00142 
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144 
<a name="l00145"></a>00145 <span class="preprocessor">#endif // ! INCLUDE_RCF_TCPCLIENTTRANSPORT_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

Web01 2.8:2024-04-02:1