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

176 lines
22 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: framework/atria-soft/zeus/zeus/BufferCall.hpp Source File</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="dir_644e041c3a6521da7b27eba0e4eb2b95.html">framework</a></li><li class="navelem"><a class="el" href="dir_a094892b17be858f66bf3446bbb755c7.html">atria-soft</a></li><li class="navelem"><a class="el" href="dir_96d802beaf7bb3afdcf2656a2c8ec44e.html">zeus</a></li><li class="navelem"><a class="el" href="dir_645a2e7aebb6c78a7ec97ee8c38ef7e7.html">zeus</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">BufferCall.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_buffer_call_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/etk.tag:http://atria-soft.github.io/etk/" href="http://atria-soft.github.io/etk/types__8hpp.html">etk/types.hpp</a>&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/enet.tag:http://atria-soft.github.io/enet/" href="http://atria-soft.github.io/enet/__web__socket__8hpp.html">enet/WebSocket.hpp</a>&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_param_type_8hpp.html">zeus/ParamType.hpp</a>&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_buffer_parameter_8hpp.html">zeus/BufferParameter.hpp</a>&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacezeus.html">zeus</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classzeus_1_1_buffer_call.html"> 14</a></span>&#160; <span class="keyword">class </span><a class="code" href="classzeus_1_1_buffer_call.html">BufferCall</a> :</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">public</span> <a class="code" href="classzeus_1_1_buffer_parameter.html">BufferParameter</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classzeus_1_1_buffer.html">zeus::Buffer</a>;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; std::string m_callName;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classzeus_1_1_buffer_call.html#a6f41ca3167420fce35bc0a25a1d3df46"> 23</a></span>&#160; <a class="code" href="classzeus_1_1_buffer_call.html#a6f41ca3167420fce35bc0a25a1d3df46">BufferCall</a>() {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="classzeus_1_1_buffer.html#aad198ff90f0335d7828a84ae2d5302ac">m_header</a>.flags = ZEUS_BUFFER_FLAG_FINISH + uint8_t(<a class="code" href="classzeus_1_1_buffer.html#ad70481d287df843b9f4a1658f20732a9a53b9e9679a8ea25880376080b76f98ad">zeus::Buffer::typeMessage::call</a>);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; };</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classzeus_1_1_buffer_call.html#a31cc072451dbf73c931e6a42f1dcf7cc">composeWith</a>(<span class="keyword">const</span> uint8_t* _buffer, uint32_t _lenght) <span class="keyword">override</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">void</span> appendBufferData(<a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/ememory.tag:http://atria-soft.github.io/ememory/" href="http://atria-soft.github.io/ememory/classememory_1_1_shared_ptr.html">ememory::SharedPtr&lt;zeus::BufferData&gt;</a> _obj) <span class="keyword">override</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classzeus_1_1_buffer_call.html#aa81004678f7749d539d5b02f2ea90adb">writeOn</a>(<a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/enet.tag:http://atria-soft.github.io/enet/" href="http://atria-soft.github.io/enet/classenet_1_1_web_socket.html">enet::WebSocket</a>&amp; _interface) <span class="keyword">override</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">void</span> generateDisplay(std::ostream&amp; _os) <span class="keyword">const override</span>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">static</span> <a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/ememory.tag:http://atria-soft.github.io/ememory/" href="http://atria-soft.github.io/ememory/classememory_1_1_shared_ptr.html">ememory::SharedPtr&lt;zeus::BufferCall&gt;</a> <a class="code" href="classzeus_1_1_buffer_call.html#ab8582bc74a93faf786c73ec458df7362">create</a>();</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classzeus_1_1_buffer_call.html#a34aee1132fbba4d9873cb1ac10c70710"> 37</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="classzeus_1_1_buffer.html#ad70481d287df843b9f4a1658f20732a9">zeus::Buffer::typeMessage</a> <a class="code" href="classzeus_1_1_buffer_call.html#a34aee1132fbba4d9873cb1ac10c70710">getType</a>()<span class="keyword"> const override </span>{</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classzeus_1_1_buffer.html#ad70481d287df843b9f4a1658f20732a9a53b9e9679a8ea25880376080b76f98ad">zeus::Buffer::typeMessage::call</a>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> std::string&amp; <a class="code" href="classzeus_1_1_buffer_call.html#abe001a99bfd42a653043a6b82c439d31">getCall</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classzeus_1_1_buffer_call.html#a475fdacd1b8be983b194d53a16750c15">setCall</a>(<span class="keyword">const</span> std::string&amp; _value);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; };</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div><div class="ttc" id="__web__socket__8hpp_html"><div class="ttname"><a href="http://atria-soft.github.io/enet/__web__socket__8hpp.html">WebSocket.hpp</a></div></div>
<div class="ttc" id="classzeus_1_1_buffer_call_html_aa81004678f7749d539d5b02f2ea90adb"><div class="ttname"><a href="classzeus_1_1_buffer_call.html#aa81004678f7749d539d5b02f2ea90adb">zeus::BufferCall::writeOn</a></div><div class="ttdeci">bool writeOn(enet::WebSocket &amp;_interface) override</div><div class="ttdoc">Write the buffer on a specific interface. </div></div>
<div class="ttc" id="classzeus_1_1_buffer_html_aad198ff90f0335d7828a84ae2d5302ac"><div class="ttname"><a href="classzeus_1_1_buffer.html#aad198ff90f0335d7828a84ae2d5302ac">zeus::Buffer::m_header</a></div><div class="ttdeci">headerBin m_header</div><div class="ttdoc">header of the protocol </div><div class="ttdef"><b>Definition:</b> Buffer.hpp:134</div></div>
<div class="ttc" id="types__8hpp_html"><div class="ttname"><a href="http://atria-soft.github.io/etk/types__8hpp.html">types.hpp</a></div></div>
<div class="ttc" id="_param_type_8hpp_html"><div class="ttname"><a href="_param_type_8hpp.html">ParamType.hpp</a></div></div>
<div class="ttc" id="classzeus_1_1_buffer_call_html_a6f41ca3167420fce35bc0a25a1d3df46"><div class="ttname"><a href="classzeus_1_1_buffer_call.html#a6f41ca3167420fce35bc0a25a1d3df46">zeus::BufferCall::BufferCall</a></div><div class="ttdeci">BufferCall()</div><div class="ttdoc">basic constructor (hidden to force the use of ememory::SharedPtr) zeus::BufferCall::create ...</div><div class="ttdef"><b>Definition:</b> BufferCall.hpp:23</div></div>
<div class="ttc" id="classzeus_1_1_buffer_call_html"><div class="ttname"><a href="classzeus_1_1_buffer_call.html">zeus::BufferCall</a></div><div class="ttdef"><b>Definition:</b> BufferCall.hpp:14</div></div>
<div class="ttc" id="classzeus_1_1_buffer_call_html_a31cc072451dbf73c931e6a42f1dcf7cc"><div class="ttname"><a href="classzeus_1_1_buffer_call.html#a31cc072451dbf73c931e6a42f1dcf7cc">zeus::BufferCall::composeWith</a></div><div class="ttdeci">void composeWith(const uint8_t *_buffer, uint32_t _lenght) override</div><div class="ttdoc">When receive new data form websocket, it might be added by this input (set all the frame ...</div></div>
<div class="ttc" id="classzeus_1_1_buffer_html"><div class="ttname"><a href="classzeus_1_1_buffer.html">zeus::Buffer</a></div><div class="ttdoc">Protocol buffer to transmit datas. </div><div class="ttdef"><b>Definition:</b> Buffer.hpp:110</div></div>
<div class="ttc" id="classzeus_1_1_buffer_call_html_abe001a99bfd42a653043a6b82c439d31"><div class="ttname"><a href="classzeus_1_1_buffer_call.html#abe001a99bfd42a653043a6b82c439d31">zeus::BufferCall::getCall</a></div><div class="ttdeci">const std::string &amp; getCall() const</div><div class="ttdoc">get the call value of the buffer </div></div>
<div class="ttc" id="classzeus_1_1_buffer_html_ad70481d287df843b9f4a1658f20732a9a53b9e9679a8ea25880376080b76f98ad"><div class="ttname"><a href="classzeus_1_1_buffer.html#ad70481d287df843b9f4a1658f20732a9a53b9e9679a8ea25880376080b76f98ad">zeus::Buffer::typeMessage::call</a></div><div class="ttdoc">Remote call on a service ID. </div></div>
<div class="ttc" id="classzeus_1_1_buffer_call_html_a475fdacd1b8be983b194d53a16750c15"><div class="ttname"><a href="classzeus_1_1_buffer_call.html#a475fdacd1b8be983b194d53a16750c15">zeus::BufferCall::setCall</a></div><div class="ttdeci">void setCall(const std::string &amp;_value)</div><div class="ttdoc">Set the call value of the buffer. </div></div>
<div class="ttc" id="classenet_1_1_web_socket_html"><div class="ttname"><a href="http://atria-soft.github.io/enet/classenet_1_1_web_socket.html">enet::WebSocket</a></div></div>
<div class="ttc" id="namespacezeus_html"><div class="ttname"><a href="namespacezeus.html">zeus</a></div><div class="ttdoc">Main zeus library namespace. </div><div class="ttdef"><b>Definition:</b> AbstractFunction.hpp:15</div></div>
<div class="ttc" id="classememory_1_1_shared_ptr_html"><div class="ttname"><a href="http://atria-soft.github.io/ememory/classememory_1_1_shared_ptr.html">ememory::SharedPtr</a></div></div>
<div class="ttc" id="classzeus_1_1_buffer_call_html_a34aee1132fbba4d9873cb1ac10c70710"><div class="ttname"><a href="classzeus_1_1_buffer_call.html#a34aee1132fbba4d9873cb1ac10c70710">zeus::BufferCall::getType</a></div><div class="ttdeci">enum zeus::Buffer::typeMessage getType() const override</div><div class="ttdoc">Get the type of the buffer. </div><div class="ttdef"><b>Definition:</b> BufferCall.hpp:37</div></div>
<div class="ttc" id="classzeus_1_1_buffer_call_html_ab8582bc74a93faf786c73ec458df7362"><div class="ttname"><a href="classzeus_1_1_buffer_call.html#ab8582bc74a93faf786c73ec458df7362">zeus::BufferCall::create</a></div><div class="ttdeci">static ememory::SharedPtr&lt; zeus::BufferCall &gt; create()</div><div class="ttdoc">Create a shared pointer on the BufferCall. </div></div>
<div class="ttc" id="classzeus_1_1_buffer_parameter_html"><div class="ttname"><a href="classzeus_1_1_buffer_parameter.html">zeus::BufferParameter</a></div><div class="ttdef"><b>Definition:</b> BufferParameter.hpp:13</div></div>
<div class="ttc" id="_buffer_parameter_8hpp_html"><div class="ttname"><a href="_buffer_parameter_8hpp.html">BufferParameter.hpp</a></div></div>
<div class="ttc" id="classzeus_1_1_buffer_html_ad70481d287df843b9f4a1658f20732a9"><div class="ttname"><a href="classzeus_1_1_buffer.html#ad70481d287df843b9f4a1658f20732a9">zeus::Buffer::typeMessage</a></div><div class="ttdeci">typeMessage</div><div class="ttdoc">Type of the massage send or receive. </div><div class="ttdef"><b>Definition:</b> Buffer.hpp:216</div></div>
</div><!-- fragment --></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