Files
Minecraft-Community-Edition/doc/html/structmce_1_1io_1_1_subscription_token.html
2026-04-02 13:39:23 +02:00

183 lines
8.2 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Minecraft Community Edition: mce::io::SubscriptionToken Struct 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Minecraft Community Edition<span id="projectnumber">&#160;0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</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',true);
$(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">
$(function(){initNavTree('structmce_1_1io_1_1_subscription_token.html','','structmce_1_1io_1_1_subscription_token-members'); });
</script>
<div id="container">
<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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">mce::io::SubscriptionToken Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Token object that controls the lifetime of an event subscription.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_q_event_bus_8hpp_source.html">QEventBus.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a029c82564998dc527c7fb1b2f2aac402" id="r_a029c82564998dc527c7fb1b2f2aac402"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a029c82564998dc527c7fb1b2f2aac402">~SubscriptionToken</a> ()</td></tr>
<tr class="memdesc:a029c82564998dc527c7fb1b2f2aac402"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a01f0a14371f96cc8592c88328ec31707" id="r_a01f0a14371f96cc8592c88328ec31707"><td class="memItemLeft">eastl::function&lt; void()&gt;&#160;</td><td class="memItemRight"><a class="el" href="#a01f0a14371f96cc8592c88328ec31707">unsubscribe</a></td></tr>
<tr class="memdesc:a01f0a14371f96cc8592c88328ec31707"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callable invoked to perform the unsubscribe action. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Token object that controls the lifetime of an event subscription. </p>
<p>The destructor will call the stored unsubscribe callable if it is set, causing the associated handler to be removed from the event bus.</p>
<p>This type is move- and copy-assignable depending on the semantics of the stored eastl::function. Use subscribeRAII to obtain a token. </p>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a029c82564998dc527c7fb1b2f2aac402" name="a029c82564998dc527c7fb1b2f2aac402"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a029c82564998dc527c7fb1b2f2aac402">&#9670;&#160;</a></span>~SubscriptionToken()</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="structmce_1_1core_1_1_subscription_token.html#a029c82564998dc527c7fb1b2f2aac402">mce::core::SubscriptionToken::~SubscriptionToken</a> </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Automatically unsubscribes if an unsubscribe callable is present. </p>
</div>
</div>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="a01f0a14371f96cc8592c88328ec31707" name="a01f0a14371f96cc8592c88328ec31707"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01f0a14371f96cc8592c88328ec31707">&#9670;&#160;</a></span>unsubscribe</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">eastl::function&lt;void()&gt; <a class="el" href="structmce_1_1core_1_1_subscription_token.html#a01f0a14371f96cc8592c88328ec31707">mce::core::SubscriptionToken::unsubscribe</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callable invoked to perform the unsubscribe action. </p>
<p>If empty, destruction of the token has no effect. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>Minecraft-Community-Edition/Core/<a class="el" href="_q_event_bus_8hpp_source.html">QEventBus.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>mce</b></li><li class="navelem"><b>io</b></li><li class="navelem"><a href="structmce_1_1io_1_1_subscription_token.html">SubscriptionToken</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>