ServerCore/html/classcore_1_1SubscriptionManager.html

175 lines
9.7 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: core::SubscriptionManager 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="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">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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"><b>core</b></li><li class="navelem"><a class="el" href="classcore_1_1SubscriptionManager.html">SubscriptionManager</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="classcore_1_1SubscriptionManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">core::SubscriptionManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for core::SubscriptionManager:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1SubscriptionManager__inherit__graph.png" border="0" usemap="#acore_1_1SubscriptionManager_inherit__map" alt="Inheritance graph"/></div>
<map name="acore_1_1SubscriptionManager_inherit__map" id="acore_1_1SubscriptionManager_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,200,107"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="40,5,165,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for core::SubscriptionManager:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1SubscriptionManager__coll__graph.png" border="0" usemap="#acore_1_1SubscriptionManager_coll__map" alt="Collaboration graph"/></div>
<map name="acore_1_1SubscriptionManager_coll__map" id="acore_1_1SubscriptionManager_coll__map">
<area shape="rect" title=" " alt="" coords="61,109,256,136"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="5,13,131,39"/>
<area shape="rect" href="classcore_1_1SubscriptionHandlerFactory.html" title=" " alt="" coords="155,5,344,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:ad1a021be5d55d1e9f0944c97f79ae9e2"><td class="memItemLeft" align="right" valign="top"><a id="ad1a021be5d55d1e9f0944c97f79ae9e2"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>add</b> (<a class="el" href="classcore_1_1Subscription.html">Subscription</a> &amp;subscription)</td></tr>
<tr class="separator:ad1a021be5d55d1e9f0944c97f79ae9e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed407c183c390f4459bb6527b30c8198"><td class="memItemLeft" align="right" valign="top"><a id="aed407c183c390f4459bb6527b30c8198"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>removeSessionSubscriptions</b> (<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session)</td></tr>
<tr class="separator:aed407c183c390f4459bb6527b30c8198"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa30bf772ad72b3f319a790662e4f8ae"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1SubscriptionManager.html#aaa30bf772ad72b3f319a790662e4f8ae">processCommand</a> (coreutils::ZString &amp;request, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session) override</td></tr>
<tr class="separator:aaa30bf772ad72b3f319a790662e4f8ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcore_1_1Command"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcore_1_1Command')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcore_1_1Command.html">core::Command</a></td></tr>
<tr class="memitem:ab6352ce5650e70a5c76c3d6e4eefd292 inherit pub_methods_classcore_1_1Command"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Command.html#ab6352ce5650e70a5c76c3d6e4eefd292">output</a> (std::stringstream &amp;out)</td></tr>
<tr class="separator:ab6352ce5650e70a5c76c3d6e4eefd292 inherit pub_methods_classcore_1_1Command"><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:a1cc00944a562efe1937b70ad5a6f3834"><td class="memItemLeft" align="right" valign="top"><a id="a1cc00944a562efe1937b70ad5a6f3834"></a>
<a class="el" href="classcore_1_1SubscriptionHandlerFactory.html">SubscriptionHandlerFactory</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>factory</b></td></tr>
<tr class="separator:a1cc00944a562efe1937b70ad5a6f3834"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aaa30bf772ad72b3f319a790662e4f8ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa30bf772ad72b3f319a790662e4f8ae">&#9670;&nbsp;</a></span>processCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int core::SubscriptionManager::processCommand </td>
<td>(</td>
<td class="paramtype">coreutils::ZString &amp;&#160;</td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;&#160;</td>
<td class="paramname"><em>session</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">request</td><td>The request that was entered by the user to invoke this command. </td></tr>
<tr><td class="paramname">session</td><td>Specify the requesting session so that the execution of the command process can return its output to the session. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 0 if execution of the command was successful. Otherwise returns a non-zero value indicating an error condition. </dd></dl>
<p>Reimplemented from <a class="el" href="classcore_1_1Command.html#a95176f2532c38ee14e3fee40ee28b1bd">core::Command</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="SubscriptionManager_8h_source.html">SubscriptionManager.h</a></li>
<li>SubscriptionManager.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>