QuasarApp/Patronum
4
0
Fork 0
mirror of https://github.com/QuasarApp/Patronum.git synced 2025-04-29 17:14:32 +00:00
Code Issues Projects Releases Wiki Activity
Patronum/doc/doxygen/html/classPatronum_1_1ISocketWraper.html
EndrII fae9791114 added doxygen docs
2020-04-18 22:43:33 +03:00

393 lines
18 KiB
HTML
Raw Blame History

<!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Patronum: Patronum::ISocketWraper Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Patronum
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classPatronum_1_1ISocketWraper.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classPatronum_1_1ISocketWraper-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Patronum::ISocketWraper Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="isocketwraper_8h_source.html">isocketwraper.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Patronum::ISocketWraper:</div>
<div class="dyncontent">
<div class="center"><img src="classPatronum_1_1ISocketWraper__inherit__graph.png" border="0" usemap="#Patronum_1_1ISocketWraper_inherit__map" alt="Inheritance graph"/></div>
<map name="Patronum_1_1ISocketWraper_inherit__map" id="Patronum_1_1ISocketWraper_inherit__map">
<area shape="rect" id="node2" href="classPatronum_1_1LocalSocket.html" title="The LocalSocket class this socket work only with locale data. " alt="" coords="13,219,171,340"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for Patronum::ISocketWraper:</div>
<div class="dyncontent">
<div class="center"><img src="classPatronum_1_1ISocketWraper__coll__graph.png" border="0" usemap="#Patronum_1_1ISocketWraper_coll__map" alt="Collaboration graph"/></div>
<map name="Patronum_1_1ISocketWraper_coll__map" id="Patronum_1_1ISocketWraper_coll__map">
</map>
</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:ad7914a777a976276748238dfcefbef15"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html#ad7914a777a976276748238dfcefbef15">ISocketWraper</a> ()</td></tr>
<tr class="separator:ad7914a777a976276748238dfcefbef15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbf0ed9cdce2b7cede462497495076e2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html#adbf0ed9cdce2b7cede462497495076e2">send</a> (const QByteArray &amp;data)=0</td></tr>
<tr class="memdesc:adbf0ed9cdce2b7cede462497495076e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">send - send data to service <a href="#adbf0ed9cdce2b7cede462497495076e2">More...</a><br /></td></tr>
<tr class="separator:adbf0ed9cdce2b7cede462497495076e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae50f7259058aed8135098ab039cb67ea"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html#ae50f7259058aed8135098ab039cb67ea">sigReceve</a> (QByteArray data)=0</td></tr>
<tr class="memdesc:ae50f7259058aed8135098ab039cb67ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">sigReceve - this method is a prototype of received data signal <a href="#ae50f7259058aed8135098ab039cb67ea">More...</a><br /></td></tr>
<tr class="separator:ae50f7259058aed8135098ab039cb67ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e9cb167c720f498c89200d2b47179f7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html#a6e9cb167c720f498c89200d2b47179f7">sigStateChanged</a> (<a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77">State</a> <a class="el" href="classPatronum_1_1ISocketWraper.html#aeb5ac9224a69d74802e530275cbc9827">state</a>)=0</td></tr>
<tr class="memdesc:a6e9cb167c720f498c89200d2b47179f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">sigStateChanged - this method is a prototype of chnage state signal <a href="#a6e9cb167c720f498c89200d2b47179f7">More...</a><br /></td></tr>
<tr class="separator:a6e9cb167c720f498c89200d2b47179f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10b5e0af6ff2b9b020b80cae7400b941"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html#a10b5e0af6ff2b9b020b80cae7400b941">isValid</a> () const =0</td></tr>
<tr class="memdesc:a10b5e0af6ff2b9b020b80cae7400b941"><td class="mdescLeft">&#160;</td><td class="mdescRight">isValid - check validation of socket <a href="#a10b5e0af6ff2b9b020b80cae7400b941">More...</a><br /></td></tr>
<tr class="separator:a10b5e0af6ff2b9b020b80cae7400b941"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ce6a5e31230dd558780cfc96f992086"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html#a2ce6a5e31230dd558780cfc96f992086">reconnect</a> ()=0</td></tr>
<tr class="memdesc:a2ce6a5e31230dd558780cfc96f992086"><td class="mdescLeft">&#160;</td><td class="mdescRight">reconnect <a href="#a2ce6a5e31230dd558780cfc96f992086">More...</a><br /></td></tr>
<tr class="separator:a2ce6a5e31230dd558780cfc96f992086"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb5ac9224a69d74802e530275cbc9827"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77">State</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html#aeb5ac9224a69d74802e530275cbc9827">state</a> () const</td></tr>
<tr class="separator:aeb5ac9224a69d74802e530275cbc9827"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a37350b99c9364b4c98707d126f620675"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77">State</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html#a37350b99c9364b4c98707d126f620675">m_state</a> = <a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77a9c77cd6f2ac6645273bfbc010caa22aa">State::Disconeccted</a></td></tr>
<tr class="separator:a37350b99c9364b4c98707d126f620675"><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 class="definition">Definition at line <a class="el" href="isocketwraper_8h_source.html#l00014">14</a> of file <a class="el" href="isocketwraper_8h_source.html">isocketwraper.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad7914a777a976276748238dfcefbef15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7914a777a976276748238dfcefbef15">&#9670;&nbsp;</a></span>ISocketWraper()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Patronum::ISocketWraper::ISocketWraper </td>
<td>(</td>
<td class="paramname"></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 class="definition">Definition at line <a class="el" href="isocketwraper_8h_source.html#l00017">17</a> of file <a class="el" href="isocketwraper_8h_source.html">isocketwraper.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a10b5e0af6ff2b9b020b80cae7400b941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10b5e0af6ff2b9b020b80cae7400b941">&#9670;&nbsp;</a></span>isValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Patronum::ISocketWraper::isValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>isValid - check validation of socket </p>
<p>Implemented in <a class="el" href="classPatronum_1_1LocalSocket.html#af377c356127078531ca56c651ba34169">Patronum::LocalSocket</a>.</p>
</div>
</div>
<a id="a2ce6a5e31230dd558780cfc96f992086"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ce6a5e31230dd558780cfc96f992086">&#9670;&nbsp;</a></span>reconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Patronum::ISocketWraper::reconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>reconnect </p>
<dl class="section return"><dt>Returns</dt><dd>true if socket connected to host; </dd></dl>
<p>Implemented in <a class="el" href="classPatronum_1_1LocalSocket.html#a6c7d161779e797084b5c6e4ea5afc090">Patronum::LocalSocket</a>.</p>
</div>
</div>
<a id="adbf0ed9cdce2b7cede462497495076e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbf0ed9cdce2b7cede462497495076e2">&#9670;&nbsp;</a></span>send()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Patronum::ISocketWraper::send </td>
<td>(</td>
<td class="paramtype">const QByteArray &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>send - send data to service </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if operation finished seccussful </dd></dl>
<p>Implemented in <a class="el" href="classPatronum_1_1LocalSocket.html#a940d36cc32f1061fd83e7c6a1df8b7ac">Patronum::LocalSocket</a>.</p>
</div>
</div>
<a id="ae50f7259058aed8135098ab039cb67ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae50f7259058aed8135098ab039cb67ea">&#9670;&nbsp;</a></span>sigReceve()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Patronum::ISocketWraper::sigReceve </td>
<td>(</td>
<td class="paramtype">QByteArray&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>sigReceve - this method is a prototype of received data signal </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>- received data </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a id="a6e9cb167c720f498c89200d2b47179f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e9cb167c720f498c89200d2b47179f7">&#9670;&nbsp;</a></span>sigStateChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Patronum::ISocketWraper::sigStateChanged </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77">State</a>&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>sigStateChanged - this method is a prototype of chnage state signal </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aeb5ac9224a69d74802e530275cbc9827"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb5ac9224a69d74802e530275cbc9827">&#9670;&nbsp;</a></span>state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77">State</a> Patronum::ISocketWraper::state </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="isocketwraper_8cpp_source.html#l00005">5</a> of file <a class="el" href="isocketwraper_8cpp_source.html">isocketwraper.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a37350b99c9364b4c98707d126f620675"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37350b99c9364b4c98707d126f620675">&#9670;&nbsp;</a></span>m_state</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77">State</a> Patronum::ISocketWraper::m_state = <a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77a9c77cd6f2ac6645273bfbc010caa22aa">State::Disconeccted</a></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 class="definition">Definition at line <a class="el" href="isocketwraper_8h_source.html#l00053">53</a> of file <a class="el" href="isocketwraper_8h_source.html">isocketwraper.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Patronum/src/<a class="el" href="isocketwraper_8h_source.html">isocketwraper.h</a></li>
<li>Patronum/src/<a class="el" href="isocketwraper_8cpp_source.html">isocketwraper.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacePatronum.html">Patronum</a></li><li class="navelem"><a class="el" href="classPatronum_1_1ISocketWraper.html">ISocketWraper</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink