 rcf-09c.zip
 RCF-0.9c
- demo
- vs2003
- RCF
- include
- RCF
- SF
 license.txt- src
- RCF
- SF
- test
- rcf-04.zip
- RCF-0.4
- demo
- vs2003
- RCF
- doc
- html
- latex
- include
- RCF
- SF
- license.txt
- src
- RCF
- SF
- test
- vs2003
- RCF
 RCF.sln- RCF
- RCF.vcproj
- RCFTest
- client.pem
- RCFTest.vcproj
- server.pem
|
<!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: RCF::ClientStub Class Reference</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 Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul></div>
<div class="nav">
<b>RCF</b>::<a class="el" href="class_r_c_f_1_1_client_stub.html">ClientStub</a></div>
<h1>RCF::ClientStub Class Reference</h1><!-- doxytag: class="RCF::ClientStub" --><code>#include <<a class="el" href="_client_stub_8hpp-source.html">ClientStub.hpp</a>></code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Manages the client side of communications between server and client.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69abd98c741f8755c7759f8e2671986d"></a><!-- doxytag: member="RCF::ClientStub::ClientStub" ref="69abd98c741f8755c7759f8e2671986d" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#69abd98c741f8755c7759f8e2671986d">ClientStub</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#b42b20150cabd95e3310a0317698db31">ClientStub</a> (const std::string &objectName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#b42b20150cabd95e3310a0317698db31"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b33413f0bcc25545634d2358604cf2b5"></a><!-- doxytag: member="RCF::ClientStub::ClientStub" ref="b33413f0bcc25545634d2358604cf2b5" args="(const ClientStub &rhs)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#b33413f0bcc25545634d2358604cf2b5">ClientStub</a> (const <a class="el" href="class_r_c_f_1_1_client_stub.html">ClientStub</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. NB - transfers ownership of the client transport! <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4869a14ab1b4ab5e0a31cca85d584a0e"></a><!-- doxytag: member="RCF::ClientStub::operator=" ref="4869a14ab1b4ab5e0a31cca85d584a0e" args="(const ClientStub &rhs)" -->
<a class="el" href="class_r_c_f_1_1_client_stub.html">ClientStub</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#4869a14ab1b4ab5e0a31cca85d584a0e">operator=</a> (const <a class="el" href="class_r_c_f_1_1_client_stub.html">ClientStub</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. NB - transfers ownership of the client transport! <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2db975facf88c6f2ef3ebfb12a05122"></a><!-- doxytag: member="RCF::ClientStub::~ClientStub" ref="f2db975facf88c6f2ef3ebfb12a05122" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#f2db975facf88c6f2ef3ebfb12a05122">~ClientStub</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#139f92668a892f0e2bd53d6c243dae4f">setEndpoint</a> (const <a class="el" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a> &endpoint)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the server endpoint to which the client will call. <a href="#139f92668a892f0e2bd53d6c243dae4f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#751d3fe2732ca637d9382cb2eb678c86">setEndpoint</a> (boost::shared_ptr< <a class="el" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a> > endpoint)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the server endpoint to which the client will call. <a href="#751d3fe2732ca637d9382cb2eb678c86"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boost::shared_ptr< <a class="el" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#4a9080da42d0258ea022c580e70106b7">getEndpoint</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of the currently set server endpoint. <a href="#4a9080da42d0258ea022c580e70106b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Token </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#9fa363d39720c9b06969544c0cf4a1ce">getToken</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the token, if any, that the client is using. <a href="#9fa363d39720c9b06969544c0cf4a1ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#6362e2f2afca03f32dbdde0236333bff">setToken</a> (Token token)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the token that the client should use in its calls to the server. <a href="#6362e2f2afca03f32dbdde0236333bff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#11f0706035b249cf21b1ba14fbac33e7">getServerBindingName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the binding name on the server that the client is accessing. <a href="#11f0706035b249cf21b1ba14fbac33e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#259b0e3776fd9b38ba2d2feff8ce8bbd">setServerBindingName</a> (const std::string &serverBindingName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the binding name on the server that the client should access on subsequent calls. <a href="#259b0e3776fd9b38ba2d2feff8ce8bbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">RemoteCallSemantics </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#cbccb4a50f59a69c88e0b35980b8a515">getDefaultCallingSemantics</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the calling semantics that the client is currently using (oneway or twoway). <a href="#cbccb4a50f59a69c88e0b35980b8a515"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#19694de7fdb0eb68736f28718ad8823b">setDefaultCallingSemantics</a> (RemoteCallSemantics defaultCallingSemantics)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the calling semantics that the client should use in subsequent calls (oneway or twoway). <a href="#19694de7fdb0eb68736f28718ad8823b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#e56f358f2a0384fa043f5f96bc5476d9">setSerializationProtocol</a> (int protocol)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the serialization protocol. <a href="#e56f358f2a0384fa043f5f96bc5476d9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#8fb80cba1bce1357b742243800b2a7ae">getSerializationProtocol</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the serialization protocol. <a href="#8fb80cba1bce1357b742243800b2a7ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#2a996d39d3e7901233762105185a280d">enableSfSerializationPointerTracking</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables pointer tracking for outbound SF serialization. <a href="#2a996d39d3e7901233762105185a280d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#9f03999a0225e53aaa0df1fccb41ed1a">setTransport</a> (std::auto_ptr< <a class="el" href="class_r_c_f_1_1_i___client_transport.html">I_ClientTransport</a> > transport)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the client transport, releasing the currently configured transport. <a href="#9f03999a0225e53aaa0df1fccb41ed1a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_r_c_f_1_1_i___client_transport.html">I_ClientTransport</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#780b5085a00d7743225ebc972607e09f">getTransport</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to currently configured client transport. <a href="#780b5085a00d7743225ebc972607e09f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::auto_ptr< <a class="el" href="class_r_c_f_1_1_i___client_transport.html">I_ClientTransport</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#629468ec702e92f4dd4a30457189a31a">releaseTransport</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases and returns the currently configured client transport. <a href="#629468ec702e92f4dd4a30457189a31a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="825c01909e542add4baa70d5eaf97789"></a><!-- doxytag: member="RCF::ClientStub::resetTransport" ref="825c01909e542add4baa70d5eaf97789" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#825c01909e542add4baa70d5eaf97789">resetTransport</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes the current client transport, and replaces it with a cloned copy. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dd76c160251e191a7e426805e33fcd0"></a><!-- doxytag: member="RCF::ClientStub::connectTransport" ref="9dd76c160251e191a7e426805e33fcd0" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#9dd76c160251e191a7e426805e33fcd0">connectTransport</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to connect the underlying client transport. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#96d2a724813e4426ff5685bc1f4b0102">isConnected</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to determine if the underlying client transport is connected. <a href="#96d2a724813e4426ff5685bc1f4b0102"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#0613f262d90e2c17ff0a9e70f043b12b">setPayloadFilters</a> (const std::vector< FilterPtr > &filters)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the payload filtering sequence. <a href="#0613f262d90e2c17ff0a9e70f043b12b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#96dcd53da3589de062830e5c65f67ee5">setPayloadFilters</a> (FilterPtr filterPtr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the payload filtering sequence. <a href="#96dcd53da3589de062830e5c65f67ee5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#b5f27c7a53da832d7ddcc600b57f674a">setTransportFilters</a> (const std::vector< FilterPtr > &filters)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the transport filtering sequence. <a href="#b5f27c7a53da832d7ddcc600b57f674a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#523992b20ce816ff10ddc59c6209c3d5">setTransportFilters</a> (FilterPtr filterPtr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the transport filtering sequence. <a href="#523992b20ce816ff10ddc59c6209c3d5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#ebe102adc29b417991d86d688bbc1571">setRemoteCallTimeoutMs</a> (unsigned int remoteCallTimeoutMs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the remote call timeout value. <a href="#ebe102adc29b417991d86d688bbc1571"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_c_f_1_1_client_stub.html#4746ab15ae9219d341f7092fa4c2d0b2">getRemoteCallTimeoutMs</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the remote call timeout value. <a href="#4746ab15ae9219d341f7092fa4c2d0b2"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b42b20150cabd95e3310a0317698db31"></a><!-- doxytag: member="RCF::ClientStub::ClientStub" ref="b42b20150cabd95e3310a0317698db31" args="(const std::string &objectName)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">RCF::ClientStub::ClientStub </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>objectName</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>objectName</em> </td><td>Name of the binding on the server which the client wants to invoke. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2a996d39d3e7901233762105185a280d"></a><!-- doxytag: member="RCF::ClientStub::enableSfSerializationPointerTracking" ref="2a996d39d3e7901233762105185a280d" args="(bool enable)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::enableSfSerializationPointerTracking </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enable</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Enables pointer tracking for outbound SF serialization.
<p>
Whether to enable or not. </td>
</tr>
</table>
<a class="anchor" name="cbccb4a50f59a69c88e0b35980b8a515"></a><!-- doxytag: member="RCF::ClientStub::getDefaultCallingSemantics" ref="cbccb4a50f59a69c88e0b35980b8a515" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">RemoteCallSemantics RCF::ClientStub::getDefaultCallingSemantics </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Gets the calling semantics that the client is currently using (oneway or twoway).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Current calling semantics. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="4a9080da42d0258ea022c580e70106b7"></a><!-- doxytag: member="RCF::ClientStub::getEndpoint" ref="4a9080da42d0258ea022c580e70106b7" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">boost::shared_ptr<<a class="el" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a>> RCF::ClientStub::getEndpoint </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns a copy of the currently set server endpoint.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Shared pointer to an endpoint. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="4746ab15ae9219d341f7092fa4c2d0b2"></a><!-- doxytag: member="RCF::ClientStub::getRemoteCallTimeoutMs" ref="4746ab15ae9219d341f7092fa4c2d0b2" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">unsigned int RCF::ClientStub::getRemoteCallTimeoutMs </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Gets the remote call timeout value.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Timeout value, in milliseconds. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="8fb80cba1bce1357b742243800b2a7ae"></a><!-- doxytag: member="RCF::ClientStub::getSerializationProtocol" ref="8fb80cba1bce1357b742243800b2a7ae" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int RCF::ClientStub::getSerializationProtocol </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Gets the serialization protocol.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Integer identifier of the currently set serialization protocol. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="11f0706035b249cf21b1ba14fbac33e7"></a><!-- doxytag: member="RCF::ClientStub::getServerBindingName" ref="11f0706035b249cf21b1ba14fbac33e7" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::string RCF::ClientStub::getServerBindingName </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Gets the binding name on the server that the client is accessing.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Name of the server binding. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="9fa363d39720c9b06969544c0cf4a1ce"></a><!-- doxytag: member="RCF::ClientStub::getToken" ref="9fa363d39720c9b06969544c0cf4a1ce" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">Token RCF::ClientStub::getToken </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Gets the token, if any, that the client is using.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Returns a copy of the token the client is using. If none, then it returns a default constructed Token. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="780b5085a00d7743225ebc972607e09f"></a><!-- doxytag: member="RCF::ClientStub::getTransport" ref="780b5085a00d7743225ebc972607e09f" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="class_r_c_f_1_1_i___client_transport.html">I_ClientTransport</a>& RCF::ClientStub::getTransport </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns a reference to currently configured client transport.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Current client transport. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="96d2a724813e4426ff5685bc1f4b0102"></a><!-- doxytag: member="RCF::ClientStub::isConnected" ref="96d2a724813e4426ff5685bc1f4b0102" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool RCF::ClientStub::isConnected </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Attempts to determine if the underlying client transport is connected.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>True if the transport is connected, false otherwise. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="629468ec702e92f4dd4a30457189a31a"></a><!-- doxytag: member="RCF::ClientStub::releaseTransport" ref="629468ec702e92f4dd4a30457189a31a" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::auto_ptr<<a class="el" href="class_r_c_f_1_1_i___client_transport.html">I_ClientTransport</a>> RCF::ClientStub::releaseTransport </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Releases and returns the currently configured client transport.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Auto pointer to client transport. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="19694de7fdb0eb68736f28718ad8823b"></a><!-- doxytag: member="RCF::ClientStub::setDefaultCallingSemantics" ref="19694de7fdb0eb68736f28718ad8823b" args="(RemoteCallSemantics defaultCallingSemantics)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setDefaultCallingSemantics </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">RemoteCallSemantics </td>
<td class="mdname1" valign="top" nowrap> <em>defaultCallingSemantics</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the calling semantics that the client should use in subsequent calls (oneway or twoway).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>defaultCallingSemantics</em> </td><td>Calling semantics to be used. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="751d3fe2732ca637d9382cb2eb678c86"></a><!-- doxytag: member="RCF::ClientStub::setEndpoint" ref="751d3fe2732ca637d9382cb2eb678c86" args="(boost::shared_ptr< I_Endpoint > endpoint)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setEndpoint </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">boost::shared_ptr< <a class="el" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a> > </td>
<td class="mdname1" valign="top" nowrap> <em>endpoint</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the server endpoint to which the client will call.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>endpoint</em> </td><td>Server endpoint. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="139f92668a892f0e2bd53d6c243dae4f"></a><!-- doxytag: member="RCF::ClientStub::setEndpoint" ref="139f92668a892f0e2bd53d6c243dae4f" args="(const I_Endpoint &endpoint)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setEndpoint </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="class_r_c_f_1_1_i___endpoint.html">I_Endpoint</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>endpoint</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the server endpoint to which the client will call.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>endpoint</em> </td><td>Server endpoint. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="96dcd53da3589de062830e5c65f67ee5"></a><!-- doxytag: member="RCF::ClientStub::setPayloadFilters" ref="96dcd53da3589de062830e5c65f67ee5" args="(FilterPtr filterPtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setPayloadFilters </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">FilterPtr </td>
<td class="mdname1" valign="top" nowrap> <em>filterPtr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the payload filtering sequence.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filterPtr</em> </td><td>Single filter. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="0613f262d90e2c17ff0a9e70f043b12b"></a><!-- doxytag: member="RCF::ClientStub::setPayloadFilters" ref="0613f262d90e2c17ff0a9e70f043b12b" args="(const std::vector< FilterPtr > &filters)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setPayloadFilters </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::vector< FilterPtr > & </td>
<td class="mdname1" valign="top" nowrap> <em>filters</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the payload filtering sequence.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filters</em> </td><td>Vector of filters, enumerated in the order in which they should be applied to unfiltered data </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ebe102adc29b417991d86d688bbc1571"></a><!-- doxytag: member="RCF::ClientStub::setRemoteCallTimeoutMs" ref="ebe102adc29b417991d86d688bbc1571" args="(unsigned int remoteCallTimeoutMs)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setRemoteCallTimeoutMs </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>remoteCallTimeoutMs</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the remote call timeout value.
<p>
By default, the timeout is set to 10 seconds. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>remoteCallTimeoutMs</em> </td><td>TImeout value, in milliseconds. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e56f358f2a0384fa043f5f96bc5476d9"></a><!-- doxytag: member="RCF::ClientStub::setSerializationProtocol" ref="e56f358f2a0384fa043f5f96bc5476d9" args="(int protocol)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setSerializationProtocol </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>protocol</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the serialization protocol.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>protocol</em> </td><td>Integer identifier of the desired serialization protocol. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="259b0e3776fd9b38ba2d2feff8ce8bbd"></a><!-- doxytag: member="RCF::ClientStub::setServerBindingName" ref="259b0e3776fd9b38ba2d2feff8ce8bbd" args="(const std::string &serverBindingName)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setServerBindingName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>serverBindingName</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the binding name on the server that the client should access on subsequent calls.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>serverBindingName</em> </td><td>Name of the server binding. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="6362e2f2afca03f32dbdde0236333bff"></a><!-- doxytag: member="RCF::ClientStub::setToken" ref="6362e2f2afca03f32dbdde0236333bff" args="(Token token)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setToken </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">Token </td>
<td class="mdname1" valign="top" nowrap> <em>token</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the token that the client should use in its calls to the server.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>token</em> </td><td>Token that the client should pass in subsequent calls to the server. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="9f03999a0225e53aaa0df1fccb41ed1a"></a><!-- doxytag: member="RCF::ClientStub::setTransport" ref="9f03999a0225e53aaa0df1fccb41ed1a" args="(std::auto_ptr< I_ClientTransport > transport)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setTransport </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::auto_ptr< <a class="el" href="class_r_c_f_1_1_i___client_transport.html">I_ClientTransport</a> > </td>
<td class="mdname1" valign="top" nowrap> <em>transport</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the client transport, releasing the currently configured transport.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>transport</em> </td><td>Client transport. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="523992b20ce816ff10ddc59c6209c3d5"></a><!-- doxytag: member="RCF::ClientStub::setTransportFilters" ref="523992b20ce816ff10ddc59c6209c3d5" args="(FilterPtr filterPtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setTransportFilters </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">FilterPtr </td>
<td class="mdname1" valign="top" nowrap> <em>filterPtr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the transport filtering sequence.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filterPtr</em> </td><td>Single filter. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="b5f27c7a53da832d7ddcc600b57f674a"></a><!-- doxytag: member="RCF::ClientStub::setTransportFilters" ref="b5f27c7a53da832d7ddcc600b57f674a" args="(const std::vector< FilterPtr > &filters)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void RCF::ClientStub::setTransportFilters </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::vector< FilterPtr > & </td>
<td class="mdname1" valign="top" nowrap> <em>filters</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the transport filtering sequence.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filters</em> </td><td>Vector of filters, enumerated in the order in which they should be applied to unfiltered data </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_client_stub_8hpp-source.html">ClientStub.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Sep 19 19:02:38 2006 for RCF by
<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.
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.
Submit an article or tip