174 lines
11 KiB
HTML
174 lines
11 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!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.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: cxx::Weak_ref< T > Class Template 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="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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.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="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.0 -->
|
|
<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('classcxx_1_1Weak__ref.html','',''); });
|
|
</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">cxx::Weak_ref< T > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Typed weak reference to an object of type <span class="tt">T</span>.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="weak__ref_source.html">weak_ref</a>></code></p>
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for cxx::Weak_ref< T >:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Weak__ref__inherit__graph.svg" width="220" height="511"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for cxx::Weak_ref< T >:</div>
|
|
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="classcxx_1_1Weak__ref__coll__graph.svg" width="220" height="511"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-inherited" class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_methods_classcxx_1_1H__list__item__t"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classcxx_1_1H__list__item__t')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classcxx_1_1H__list__item__t.html">cxx::H_list_item_t< Weak_ref_base ></a></td></tr>
|
|
<tr class="memitem:a386713e30171daa23a74e55ccd294382 inherit pub_methods_classcxx_1_1H__list__item__t" id="r_a386713e30171daa23a74e55ccd294382"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcxx_1_1H__list__item__t.html#a386713e30171daa23a74e55ccd294382">H_list_item_t</a> ()</td></tr>
|
|
<tr class="memdesc:a386713e30171daa23a74e55ccd294382 inherit pub_methods_classcxx_1_1H__list__item__t"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
|
|
<tr class="memitem:a4d7651de09d0ed046db094adca054859 inherit pub_methods_classcxx_1_1H__list__item__t" id="r_a4d7651de09d0ed046db094adca054859"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcxx_1_1H__list__item__t.html#a4d7651de09d0ed046db094adca054859">~H_list_item_t</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a4d7651de09d0ed046db094adca054859 inherit pub_methods_classcxx_1_1H__list__item__t"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename T><br />
|
|
class cxx::Weak_ref< T ></div><p>Typed weak reference to an object of type <span class="tt">T</span>. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The type of the referenced object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>A weak reference is a reference that is invalidated when the referenced object is about to be deleted. All weak references to an object are kept in a linked list (see <a class="el" href="structcxx_1_1Weak__ref__base_1_1List.html" title="The list type for keeping all weak references to an object.">Weak_ref_base::List</a>) and all the weak references are iterated and reset by the <a class="el" href="structcxx_1_1Weak__ref__base_1_1List.html" title="The list type for keeping all weak references to an object.">Weak_ref_base::List</a> destructor or Weak_ref_base::List::reset().</p>
|
|
<p>The type <span class="tt">T</span> must provide two methods that handle the housekeeping of weak references: <span class="tt">remove_weak_ref(Weak_ref_base *)</span> and <span class="tt">add_weak_ref(Weak_ref_base *)</span>. These functions must handle the insertion and removal of the weak reference into the respective <a class="el" href="structcxx_1_1Weak__ref__base_1_1List.html" title="The list type for keeping all weak references to an object.">Weak_ref_base::List</a> object. For convenience one can use the cxx::Weak_ref_obj as a base class that handles weak references for you.</p>
|
|
<p>For example: </p><div class="fragment"><div class="line"><span class="keyword">class </span>C : <span class="keyword">public</span> cxx::Weak_ref_obj {};</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordtype">int</span> main()</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <a class="code hl_class" href="classcxx_1_1Weak__ref.html">cxx::Weak_ref<C></a> r; <span class="comment">// r is nullptr</span></div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> C c;</div>
|
|
<div class="line"> r = &c; <span class="comment">// now r points to c</span></div>
|
|
<div class="line"> } <span class="comment">// c is destructed, which implies resetting all weak references to c</span></div>
|
|
<div class="line"> <span class="comment">// now r is nullptr</span></div>
|
|
<div class="line"> <span class="keywordflow">return</span> 0;</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="aclasscxx_1_1Weak__ref_html"><div class="ttname"><a href="classcxx_1_1Weak__ref.html">cxx::Weak_ref</a></div><div class="ttdoc">Typed weak reference to an object of type T.</div><div class="ttdef"><b>Definition</b> <a href="weak__ref_source.html#l00095">weak_ref:96</a></div></div>
|
|
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>Weak references have no effect on the lifetime of the referenced object. Hence, a referenced object is <em>not</em> deleted when all weak references for it are gone. If automatic deletion is needed, see <a class="el" href="classcxx_1_1Ref__ptr.html" title="A reference-counting pointer with automatic cleanup.">cxx::Ref_ptr</a>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="weak__ref_source.html#l00095">95</a> of file <a class="el" href="weak__ref_source.html">weak_ref</a>.</p>
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>l4/cxx/<a class="el" href="weak__ref_source.html">weak_ref</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 -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="namespacecxx.html">cxx</a></li><li class="navelem"><a href="classcxx_1_1Weak__ref.html">Weak_ref</a></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|