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

268 lines
16 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 Namespace 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('namespacePatronum.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="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Patronum Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1Controller.html">Controller</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classPatronum_1_1Controller.html" title="The Controller class provide control functionality for your service how to use : just inherit from th...">Controller</a> class provide control functionality for your service how to use : just inherit from the <a class="el" href="classPatronum_1_1Service.html">Service</a> <a class="el" href="classPatronum_1_1Controller.html" title="The Controller class provide control functionality for your service how to use : just inherit from th...">Controller</a> and override the methods you need. So, invoke the send methon, and if you need to get a responce from your service then invoke a waitForResponce method. <a href="classPatronum_1_1Controller.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1Feature.html">Feature</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classPatronum_1_1Feature.html" title="The Feature class - it is atomic type for describe service command. ">Feature</a> class - it is atomic type for describe service command. <a href="classPatronum_1_1Feature.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1IController.html">IController</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1IService.html">IService</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ISocketWraper.html">ISocketWraper</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1LocalSocket.html">LocalSocket</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classPatronum_1_1LocalSocket.html" title="The LocalSocket class this socket work only with locale data. ">LocalSocket</a> class this socket work only with locale data. <a href="classPatronum_1_1LocalSocket.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPatronum_1_1Package.html">Package</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1Service.html">Service</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1ServicePrivate.html">ServicePrivate</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a77e016e9a8d3ac9736e6a094183d7c77"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77">State</a> : int { <a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77a2ec0d16e4ca169baedb9b2d50ec5c6d7">State::Connected</a>,
<a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77a9c77cd6f2ac6645273bfbc010caa22aa">State::Disconeccted</a>
}</td></tr>
<tr class="separator:a77e016e9a8d3ac9736e6a094183d7c77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9869ecf6d22f9a65de07171858a746c5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePatronum.html#a9869ecf6d22f9a65de07171858a746c5">Command</a> : char { <a class="el" href="namespacePatronum.html#a9869ecf6d22f9a65de07171858a746c5a239a22f50c80b1427131972c961d918a">Command::FeaturesRequest</a>,
<a class="el" href="namespacePatronum.html#a9869ecf6d22f9a65de07171858a746c5a98f770b0af18ca763421bac22b4b6805">Command::Features</a>,
<a class="el" href="namespacePatronum.html#a9869ecf6d22f9a65de07171858a746c5a21021ea0e52be8e9c599f4dff41e5be0">Command::Feature</a>,
<a class="el" href="namespacePatronum.html#a9869ecf6d22f9a65de07171858a746c5a8a62e0d329546f13e7adf3e0bf9ef0bc">Command::FeatureResponce</a>
}</td></tr>
<tr class="separator:a9869ecf6d22f9a65de07171858a746c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a413684fdfd24b4a728db98a5ac3103c0"><td class="memItemLeft" align="right" valign="top">QDataStream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePatronum.html#a413684fdfd24b4a728db98a5ac3103c0">operator&lt;&lt;</a> (QDataStream &amp;stream, const <a class="el" href="classPatronum_1_1Feature.html">Feature</a> &amp;obj)</td></tr>
<tr class="separator:a413684fdfd24b4a728db98a5ac3103c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab168a4df2f98ad4db62b9525a87da2c1"><td class="memItemLeft" align="right" valign="top">QDataStream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePatronum.html#ab168a4df2f98ad4db62b9525a87da2c1">operator&gt;&gt;</a> (QDataStream &amp;stream, <a class="el" href="classPatronum_1_1Feature.html">Feature</a> &amp;obj)</td></tr>
<tr class="separator:ab168a4df2f98ad4db62b9525a87da2c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a9869ecf6d22f9a65de07171858a746c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9869ecf6d22f9a65de07171858a746c5">&#9670;&nbsp;</a></span>Command</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacePatronum.html#a9869ecf6d22f9a65de07171858a746c5">Patronum::Command</a> : char</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9869ecf6d22f9a65de07171858a746c5a239a22f50c80b1427131972c961d918a"></a>FeaturesRequest&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9869ecf6d22f9a65de07171858a746c5a98f770b0af18ca763421bac22b4b6805"></a>Features&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9869ecf6d22f9a65de07171858a746c5a21021ea0e52be8e9c599f4dff41e5be0"></a>Feature&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9869ecf6d22f9a65de07171858a746c5a8a62e0d329546f13e7adf3e0bf9ef0bc"></a>FeatureResponce&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="package_8h_source.html#l00008">8</a> of file <a class="el" href="package_8h_source.html">package.h</a>.</p>
</div>
</div>
<a id="a77e016e9a8d3ac9736e6a094183d7c77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77e016e9a8d3ac9736e6a094183d7c77">&#9670;&nbsp;</a></span>State</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacePatronum.html#a77e016e9a8d3ac9736e6a094183d7c77">Patronum::State</a> : int</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a77e016e9a8d3ac9736e6a094183d7c77a2ec0d16e4ca169baedb9b2d50ec5c6d7"></a>Connected&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a77e016e9a8d3ac9736e6a094183d7c77a9c77cd6f2ac6645273bfbc010caa22aa"></a>Disconeccted&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="isocketwraper_8h_source.html#l00009">9</a> of file <a class="el" href="isocketwraper_8h_source.html">isocketwraper.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a413684fdfd24b4a728db98a5ac3103c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a413684fdfd24b4a728db98a5ac3103c0">&#9670;&nbsp;</a></span>operator<<()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QDataStream&amp; Patronum::operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">QDataStream &amp;&#160;</td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPatronum_1_1Feature.html">Feature</a> &amp;&#160;</td>
<td class="paramname"><em>obj</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="feature_8cpp_source.html#l00047">47</a> of file <a class="el" href="feature_8cpp_source.html">feature.cpp</a>.</p>
</div>
</div>
<a id="ab168a4df2f98ad4db62b9525a87da2c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab168a4df2f98ad4db62b9525a87da2c1">&#9670;&nbsp;</a></span>operator>>()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QDataStream&amp; Patronum::operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype">QDataStream &amp;&#160;</td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPatronum_1_1Feature.html">Feature</a> &amp;&#160;</td>
<td class="paramname"><em>obj</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="feature_8cpp_source.html#l00053">53</a> of file <a class="el" href="feature_8cpp_source.html">feature.cpp</a>.</p>
</div>
</div>
</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="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