atria-soft/zeus
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
zeus/classzeus_1_1_client.html

605 lines
31 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>zeus: Zeus ewol micro-service interface: zeus::Client Class Reference</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">zeus: Zeus ewol micro-service interface 0.4.0</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Main&nbsp;Page</a></li>
<li><a href="pages.html">Related&nbsp;Pages</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
Link-libs<span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
<li><a href="http://atria-soft.github.io/echrono">echrono</a></li>
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
<li><a href="http://atria-soft.github.io/etranslate">etranslate</a></li>
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
<li><a href="http://musicdsp.github.io/audio-ess">audio-ess</a></li>
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
</ul>
</li>
</ul>
<div id="search-box" class="input-group">
<div class="input-group-btn">
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
<span class="glyphicon glyphicon-search"></span>
<span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a href="#">All</a></li>
<li><a href="#">Classes</a></li>
<li><a href="#">Namespaces</a></li>
<li><a href="#">Files</a></li>
<li><a href="#">Functions</a></li>
<li><a href="#">Variables</a></li>
<li><a href="#">Typedefs</a></li>
<li><a href="#">Enumerations</a></li>
<li><a href="#">Enumerator</a></li>
<li><a href="#">Friends</a></li>
<li><a href="#">Macros</a></li>
<li><a href="#">Pages</a></li>
</ul>
</div>
<button id="search-close" type="button" class="close" aria-label="Close">
<span aria-hidden="true"></span>
</button>
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;margin-top: 60px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacezeus.html">zeus</a></li><li class="navelem"><a class="el" href="classzeus_1_1_client.html">Client</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classzeus_1_1_client-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">zeus::Client Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_client_8hpp_source.html">Client.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for zeus::Client:</div>
<div class="dyncontent">
<div class="center">
<img src="classzeus_1_1_client.png" usemap="#zeus::Client_map" alt=""/>
<map id="zeus::Client_map" name="zeus::Client_map">
<area doxygen="/home/heero/dev/perso/out/doc/release/eproperty.tag:http://atria-soft.github.io/eproperty/" href="http://atria-soft.github.io/eproperty/classeproperty_1_1_interface.html" alt="eproperty::Interface" shape="rect" coords="0,0,123,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3a10e70d2386b88cf1f9bb615ea2f582"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#a3a10e70d2386b88cf1f9bb615ea2f582">Client</a> ()</td></tr>
<tr class="separator:a3a10e70d2386b88cf1f9bb615ea2f582"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9302c059ea4fd9b564af41d524ac49c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#af9302c059ea4fd9b564af41d524ac49c">~Client</a> ()</td></tr>
<tr class="separator:af9302c059ea4fd9b564af41d524ac49c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8b42ee062476505a9e7b449aa6ae8e9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#af8b42ee062476505a9e7b449aa6ae8e9">connect</a> (const std::string &amp;_address)</td></tr>
<tr class="separator:af8b42ee062476505a9e7b449aa6ae8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4af6acc8640b3090a20a595cca9d3f15"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#a4af6acc8640b3090a20a595cca9d3f15">connect</a> (const std::string &amp;_address, const std::string &amp;_userPassword)</td></tr>
<tr class="separator:a4af6acc8640b3090a20a595cca9d3f15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2fe067881d3fa9c341c7e586fa016aa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#ad2fe067881d3fa9c341c7e586fa016aa">connect</a> (const std::string &amp;_address, const std::string &amp;_clientName, const std::string &amp;_clientTocken)</td></tr>
<tr class="separator:ad2fe067881d3fa9c341c7e586fa016aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37f95679ea94427cf673110465f4f42c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#a37f95679ea94427cf673110465f4f42c">disconnect</a> ()</td></tr>
<tr class="separator:a37f95679ea94427cf673110465f4f42c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18c9a92a93dc2abc6817e576fa4c7ca4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classzeus_1_1_service_remote.html">zeus::ServiceRemote</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#a18c9a92a93dc2abc6817e576fa4c7ca4">getService</a> (const std::string &amp;_serviceName)</td></tr>
<tr class="separator:a18c9a92a93dc2abc6817e576fa4c7ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1a617dad4121cf70b5b5b62a158cab9"><td class="memTemplParams" colspan="2">template&lt;class... _ARGS&gt; </td></tr>
<tr class="memitem:ad1a617dad4121cf70b5b5b62a158cab9"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classzeus_1_1_future_base.html">zeus::FutureBase</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#ad1a617dad4121cf70b5b5b62a158cab9">call</a> (const std::string &amp;_functionName, _ARGS &amp;&amp;... _args)</td></tr>
<tr class="separator:ad1a617dad4121cf70b5b5b62a158cab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad11fc4d69ce0d35534dd759c4076aad1"><td class="memTemplParams" colspan="2">template&lt;class... _ARGS&gt; </td></tr>
<tr class="memitem:ad11fc4d69ce0d35534dd759c4076aad1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classzeus_1_1_future_base.html">zeus::FutureBase</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#ad11fc4d69ce0d35534dd759c4076aad1">callAction</a> (const std::string &amp;_functionName, _ARGS &amp;&amp;... _args, <a class="el" href="classzeus_1_1_future_data.html#a3b1948b6d64c0e90fcd19dea2ed182f5">zeus::FutureData::ObserverFinish</a> _callback)</td></tr>
<tr class="separator:ad11fc4d69ce0d35534dd759c4076aad1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a159e7049f013c25cf95ec2017ef88885"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/heero/dev/perso/out/doc/release/eproperty.tag:http://atria-soft.github.io/eproperty/" href="http://atria-soft.github.io/eproperty/classeproperty_1_1_value.html">eproperty::Value</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#a159e7049f013c25cf95ec2017ef88885">propertyIp</a></td></tr>
<tr class="separator:a159e7049f013c25cf95ec2017ef88885"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35b2325791ec35f1df8ac9925a03e41d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="/home/heero/dev/perso/out/doc/release/eproperty.tag:http://atria-soft.github.io/eproperty/" href="http://atria-soft.github.io/eproperty/classeproperty_1_1_value.html">eproperty::Value</a>&lt; uint16_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#a35b2325791ec35f1df8ac9925a03e41d">propertyPort</a></td></tr>
<tr class="separator:a35b2325791ec35f1df8ac9925a03e41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classeproperty_1_1_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classeproperty_1_1_interface')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="http://atria-soft.github.io/eproperty/classeproperty_1_1_interface.html">eproperty::Interface</a></td></tr>
<tr class="memitem:a3670955b0c5e36457ceb8710c84093d4 inherit pub_attribs_classeproperty_1_1_interface"><td class="memItemLeft" align="right" valign="top"><a id="a3670955b0c5e36457ceb8710c84093d4"></a>
<a class="elRef" doxygen="/home/heero/dev/perso/out/doc/release/eproperty.tag:http://atria-soft.github.io/eproperty/" href="http://atria-soft.github.io/eproperty/classeproperty_1_1_interface_data.html">eproperty::InterfaceData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" doxygen="/home/heero/dev/perso/out/doc/release/eproperty.tag:http://atria-soft.github.io/eproperty/" href="http://atria-soft.github.io/eproperty/classeproperty_1_1_interface.html#a3670955b0c5e36457ceb8710c84093d4">properties</a></td></tr>
<tr class="separator:a3670955b0c5e36457ceb8710c84093d4 inherit pub_attribs_classeproperty_1_1_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a3bdc86ddcb5504b7636d069dc003e086"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_client.html#a3bdc86ddcb5504b7636d069dc003e086">connectTo</a> (const std::string &amp;_address)</td></tr>
<tr class="separator:a3bdc86ddcb5504b7636d069dc003e086"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a8ac915fb8f6978f1f386cbca70efd7d6"><td class="memItemLeft" align="right" valign="top"><a id="a8ac915fb8f6978f1f386cbca70efd7d6"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>ServiceRemote</b></td></tr>
<tr class="separator:a8ac915fb8f6978f1f386cbca70efd7d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classzeus_1_1_client.html" title="Client interface to acces on the remote service and gateway. ">Client</a> interface to acces on the remote service and gateway. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3a10e70d2386b88cf1f9bb615ea2f582"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a10e70d2386b88cf1f9bb615ea2f582">&sect;&nbsp;</a></span>Client()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">zeus::Client::Client </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a client on a specific user in a client mode with the tocken associated. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_address</td><td>Address of the user: "ABCD.efgh#atria-soft.com:1993" </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af9302c059ea4fd9b564af41d524ac49c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9302c059ea4fd9b564af41d524ac49c">&sect;&nbsp;</a></span>~Client()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual zeus::Client::~Client </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad1a617dad4121cf70b5b5b62a158cab9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1a617dad4121cf70b5b5b62a158cab9">&sect;&nbsp;</a></span>call()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class... _ARGS&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classzeus_1_1_future_base.html">zeus::FutureBase</a> zeus::Client::call </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_functionName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_ARGS &amp;&amp;...&#160;</td>
<td class="paramname"><em>_args</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a call on the interface gateway. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_functionName</td><td>name of the function to call </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_args...</td><td>multiple argument neededs </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a future that will contain the aswer when receiveed (need to transmit over ethernet) </dd></dl>
</div>
</div>
<a id="ad11fc4d69ce0d35534dd759c4076aad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad11fc4d69ce0d35534dd759c4076aad1">&sect;&nbsp;</a></span>callAction()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class... _ARGS&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classzeus_1_1_future_base.html">zeus::FutureBase</a> zeus::Client::callAction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_functionName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_ARGS &amp;&amp;...&#160;</td>
<td class="paramname"><em>_args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classzeus_1_1_future_data.html#a3b1948b6d64c0e90fcd19dea2ed182f5">zeus::FutureData::ObserverFinish</a>&#160;</td>
<td class="paramname"><em>_callback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a call on the interface gateway. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_functionName</td><td>name of the function to call </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_args...</td><td>multiple argument neededs </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_callback</td><td>Observer to call when the data is compleately arrived </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a future that will contain the aswer when receiveed (need to transmit over ethernet) </dd></dl>
</div>
</div>
<a id="af8b42ee062476505a9e7b449aa6ae8e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8b42ee062476505a9e7b449aa6ae8e9">&sect;&nbsp;</a></span>connect() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool zeus::Client::connect </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a client on a specific user in an ANONIMOUS way. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_address</td><td>Address of the user: "ABCD.efgh~atria-soft.com:1993" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4af6acc8640b3090a20a595cca9d3f15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4af6acc8640b3090a20a595cca9d3f15">&sect;&nbsp;</a></span>connect() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool zeus::Client::connect </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_userPassword</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a client on a specific user in a user mode (connect to your personnal account) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_address</td><td>Address of the user: "ABCD.efgh~atria-soft.com:1993" </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_userPassword</td><td>Password of the user </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad2fe067881d3fa9c341c7e586fa016aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2fe067881d3fa9c341c7e586fa016aa">&sect;&nbsp;</a></span>connect() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool zeus::Client::connect </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_clientName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_clientTocken</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a client on a specific user in a client mode with the tocken associated. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_address</td><td>Address of the user: "ABCD.efgh~atria-soft.com:1993" </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3bdc86ddcb5504b7636d069dc003e086"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bdc86ddcb5504b7636d069dc003e086">&sect;&nbsp;</a></span>connectTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool zeus::Client::connectTo </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_address</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Connetc to a remote extern server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_address</td><td>Address of the user: "ABCD.efgh~atria-soft.com:1993" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a37f95679ea94427cf673110465f4f42c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37f95679ea94427cf673110465f4f42c">&sect;&nbsp;</a></span>disconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void zeus::Client::disconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnect of the current interface. </p>
</div>
</div>
<a id="a18c9a92a93dc2abc6817e576fa4c7ca4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18c9a92a93dc2abc6817e576fa4c7ca4">&sect;&nbsp;</a></span>getService()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classzeus_1_1_service_remote.html">zeus::ServiceRemote</a> zeus::Client::getService </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_serviceName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a remote service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_serviceName</td><td>Name of the service </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer on an interface of remote service </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a159e7049f013c25cf95ec2017ef88885"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a159e7049f013c25cf95ec2017ef88885">&sect;&nbsp;</a></span>propertyIp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/heero/dev/perso/out/doc/release/eproperty.tag:http://atria-soft.github.io/eproperty/" href="http://atria-soft.github.io/eproperty/classeproperty_1_1_value.html">eproperty::Value</a>&lt;std::string&gt; zeus::Client::propertyIp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ip of WebSocket TCP connection. </p>
</div>
</div>
<a id="a35b2325791ec35f1df8ac9925a03e41d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35b2325791ec35f1df8ac9925a03e41d">&sect;&nbsp;</a></span>propertyPort</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="/home/heero/dev/perso/out/doc/release/eproperty.tag:http://atria-soft.github.io/eproperty/" href="http://atria-soft.github.io/eproperty/classeproperty_1_1_value.html">eproperty::Value</a>&lt;uint16_t&gt; zeus::Client::propertyPort</td>
</tr>
</table>
</div><div class="memdoc">
<p>Port of the WebSocket connection. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>framework/atria-soft/zeus/zeus/<a class="el" href="_client_8hpp_source.html">Client.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 24 2016 15:35:54 for zeus: Zeus ewol micro-service interface by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink