ServerCore/html/classcore_1_1Subscription.html
2023-06-10 19:27:22 -07:00

160 lines
12 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::Subscription 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_1Subscription.html">Subscription</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_1Subscription-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">core::Subscription Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for core::Subscription:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1Subscription__coll__graph.png" border="0" usemap="#acore_1_1Subscription_coll__map" alt="Collaboration graph"/></div>
<map name="acore_1_1Subscription_coll__map" id="acore_1_1Subscription_coll__map">
<area shape="rect" title=" " alt="" coords="1711,32,1849,59"/>
<area shape="rect" href="classcore_1_1SubscriptionHandler.html" title=" " alt="" coords="1420,7,1609,33"/>
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="1448,57,1581,84"/>
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="955,80,1081,107"/>
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="1201,161,1327,188"/>
<area shape="rect" href="classcore_1_1Socket.html" title=" " alt="" coords="695,123,796,149"/>
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="345,123,436,149"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="37,173,163,200"/>
<area shape="rect" href="classcore_1_1CommandList.html" title=" " alt="" coords="512,179,660,205"/>
<area shape="rect" href="classcore_1_1SubscriptionManager.html" title=" " alt="" coords="293,235,488,261"/>
<area shape="rect" href="classcore_1_1IPAddress.html" title=" " alt="" coords="684,72,807,99"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="341,72,441,99"/>
<area shape="rect" href="classcore_1_1IPAddressList.html" title=" " alt="" coords="945,133,1091,160"/>
<area shape="rect" href="classcore_1_1SubscriptionHandlerFactory.html" title=" " alt="" coords="5,234,195,275"/>
</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:a348a4ec8232ada37f5be2b6f756f01f3"><td class="memItemLeft" align="right" valign="top"><a id="a348a4ec8232ada37f5be2b6f756f01f3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Subscription</b> (std::string id, std::string mode=&quot;*AUTHOR&quot;)</td></tr>
<tr class="separator:a348a4ec8232ada37f5be2b6f756f01f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b993509cd113d8ed564d710955c94a0"><td class="memItemLeft" align="right" valign="top"><a id="a1b993509cd113d8ed564d710955c94a0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Subscription</b> (std::string id, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session, std::string mode)</td></tr>
<tr class="separator:a1b993509cd113d8ed564d710955c94a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae21b7a4a1084da8959cd8022fa138c0e"><td class="memItemLeft" align="right" valign="top"><a id="ae21b7a4a1084da8959cd8022fa138c0e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Subscription</b> (std::string id, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session, std::string mode, <a class="el" href="classcore_1_1SubscriptionHandler.html">SubscriptionHandler</a> *handler)</td></tr>
<tr class="separator:ae21b7a4a1084da8959cd8022fa138c0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57c23d7c49328eecf8358f84b485f7cb"><td class="memItemLeft" align="right" valign="top"><a id="a57c23d7c49328eecf8358f84b485f7cb"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>subscribe</b> (<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session)</td></tr>
<tr class="separator:a57c23d7c49328eecf8358f84b485f7cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b6d9f10c605f20c7e27c308577ab8d4"><td class="memItemLeft" align="right" valign="top"><a id="a4b6d9f10c605f20c7e27c308577ab8d4"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>unsubscribe</b> (<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session)</td></tr>
<tr class="separator:a4b6d9f10c605f20c7e27c308577ab8d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe97bd6c3c714df84381fdd6d66e5037"><td class="memItemLeft" align="right" valign="top"><a id="afe97bd6c3c714df84381fdd6d66e5037"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>process</b> (coreutils::ZString &amp;request, std::stringstream &amp;out, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session)</td></tr>
<tr class="separator:afe97bd6c3c714df84381fdd6d66e5037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4f32bfd024a3609ad795876860088d9"><td class="memItemLeft" align="right" valign="top"><a id="aa4f32bfd024a3609ad795876860088d9"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>onSubscribe</b> (<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session, <a class="el" href="classcore_1_1Subscription.html">Subscription</a> *subscription)</td></tr>
<tr class="separator:aa4f32bfd024a3609ad795876860088d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfd211503f5eccfda620995de58c73f9"><td class="memItemLeft" align="right" valign="top"><a id="adfd211503f5eccfda620995de58c73f9"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>event</b> (std::stringstream &amp;out)</td></tr>
<tr class="separator:adfd211503f5eccfda620995de58c73f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addf187a8e97c2be1ac0cce9c21da5a28"><td class="memItemLeft" align="right" valign="top"><a id="addf187a8e97c2be1ac0cce9c21da5a28"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ifSubscriber</b> (<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session)</td></tr>
<tr class="separator:addf187a8e97c2be1ac0cce9c21da5a28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae12af263ca5355c7217d1bf015bba5f"><td class="memItemLeft" align="right" valign="top"><a id="aae12af263ca5355c7217d1bf015bba5f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>subInvite</b> (<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session)</td></tr>
<tr class="separator:aae12af263ca5355c7217d1bf015bba5f"><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:a6a952ecf3d9d4a2c69c6b09c3c5c6cb2"><td class="memItemLeft" align="right" valign="top"><a id="a6a952ecf3d9d4a2c69c6b09c3c5c6cb2"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>id</b></td></tr>
<tr class="separator:a6a952ecf3d9d4a2c69c6b09c3c5c6cb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f7d38b845a674d860fd78aa7cdd5858"><td class="memItemLeft" align="right" valign="top"><a id="a5f7d38b845a674d860fd78aa7cdd5858"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>mode</b></td></tr>
<tr class="separator:a5f7d38b845a674d860fd78aa7cdd5858"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5526427600aa4a5b180f76f201e85f58"><td class="memItemLeft" align="right" valign="top"><a id="a5526427600aa4a5b180f76f201e85f58"></a>
<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>owner</b></td></tr>
<tr class="separator:a5526427600aa4a5b180f76f201e85f58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4f020e6bdee846121f508fcdb6f7aeb"><td class="memItemLeft" align="right" valign="top"><a id="ab4f020e6bdee846121f508fcdb6f7aeb"></a>
<a class="el" href="classcore_1_1SubscriptionHandler.html">SubscriptionHandler</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>handler</b></td></tr>
<tr class="separator:ab4f020e6bdee846121f508fcdb6f7aeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1a5c1a3e5a6e253eb34795f43d4f9be"><td class="memItemLeft" align="right" valign="top"><a id="ad1a5c1a3e5a6e253eb34795f43d4f9be"></a>
std::vector&lt; <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>subscribers</b></td></tr>
<tr class="separator:ad1a5c1a3e5a6e253eb34795f43d4f9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Subscription_8h_source.html">Subscription.h</a></li>
<li>Subscription.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>