Files
rippled/structripple_1_1peer__in__cluster.html
2025-11-04 00:36:48 -08:00

183 lines
9.6 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::peer_in_cluster 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>
<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">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="structripple_1_1peer__in__cluster.html">peer_in_cluster</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="structripple_1_1peer__in__cluster-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::peer_in_cluster Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Select all peers (except optional excluded) that are in our cluster.
<a href="structripple_1_1peer__in__cluster.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="predicates_8h_source.html">predicates.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::peer_in_cluster:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1peer__in__cluster__coll__graph.png" border="0" usemap="#aripple_1_1peer__in__cluster_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1peer__in__cluster_coll__map" id="aripple_1_1peer__in__cluster_coll__map">
<area shape="rect" title="Select all peers (except optional excluded) that are in our cluster." alt="" coords="5,181,172,207"/>
<area shape="rect" href="structripple_1_1match__peer.html" title="Select the specific peer." alt="" coords="17,93,161,119"/>
<area shape="poly" title=" " alt="" coords="91,133,91,181,86,181,86,133"/>
<area shape="rect" href="classripple_1_1Peer.html" title="Represents a peer connection in the overlay." alt="" coords="41,5,137,31"/>
<area shape="poly" title=" " alt="" coords="91,45,91,93,86,93,86,45"/>
</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8bfb53aecc6cb8f084bfbf6cf5275665" id="r_a8bfb53aecc6cb8f084bfbf6cf5275665"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1peer__in__cluster.html#a8bfb53aecc6cb8f084bfbf6cf5275665">peer_in_cluster</a> (<a class="el" href="classripple_1_1Peer.html">Peer</a> const *skip=nullptr)</td></tr>
<tr class="separator:a8bfb53aecc6cb8f084bfbf6cf5275665"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f044e2cbfaf9cdf94f17d1f7aef24ed" id="r_a7f044e2cbfaf9cdf94f17d1f7aef24ed"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1peer__in__cluster.html#a7f044e2cbfaf9cdf94f17d1f7aef24ed">operator()</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;peer) const</td></tr>
<tr class="separator:a7f044e2cbfaf9cdf94f17d1f7aef24ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2ac211db12a1a580890c71d7c6f4d36e" id="r_a2ac211db12a1a580890c71d7c6f4d36e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1match__peer.html">match_peer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1peer__in__cluster.html#a2ac211db12a1a580890c71d7c6f4d36e">skipPeer</a></td></tr>
<tr class="separator:a2ac211db12a1a580890c71d7c6f4d36e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Select all peers (except optional excluded) that are in our cluster. </p>
<p class="definition">Definition at line <a class="el" href="predicates_8h_source.html#l00117">117</a> of file <a class="el" href="predicates_8h_source.html">predicates.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8bfb53aecc6cb8f084bfbf6cf5275665" name="a8bfb53aecc6cb8f084bfbf6cf5275665"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bfb53aecc6cb8f084bfbf6cf5275665">&#9670;&#160;</a></span>peer_in_cluster()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::peer_in_cluster::peer_in_cluster </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Peer.html">Peer</a> const *&#160;</td>
<td class="paramname"><em>skip</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="predicates_8h_source.html#l00121">121</a> of file <a class="el" href="predicates_8h_source.html">predicates.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7f044e2cbfaf9cdf94f17d1f7aef24ed" name="a7f044e2cbfaf9cdf94f17d1f7aef24ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f044e2cbfaf9cdf94f17d1f7aef24ed">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::peer_in_cluster::operator() </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>peer</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="predicates_8h_source.html#l00126">126</a> of file <a class="el" href="predicates_8h_source.html">predicates.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2ac211db12a1a580890c71d7c6f4d36e" name="a2ac211db12a1a580890c71d7c6f4d36e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ac211db12a1a580890c71d7c6f4d36e">&#9670;&#160;</a></span>skipPeer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1match__peer.html">match_peer</a> ripple::peer_in_cluster::skipPeer</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="predicates_8h_source.html#l00119">119</a> of file <a class="el" href="predicates_8h_source.html">predicates.h</a>.</p>
</div>
</div>
</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.8
</small></address>
</body>
</html>