mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
218 lines
13 KiB
HTML
218 lines
13 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::send_always 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&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&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_1send__always.html">send_always</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structripple_1_1send__always-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::send_always Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Sends a message to all peers.
|
|
<a href="structripple_1_1send__always.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="predicates_8h_source.html">predicates.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::send_always:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="structripple_1_1send__always__coll__graph.png" border="0" usemap="#aripple_1_1send__always_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1send__always_coll__map" id="aripple_1_1send__always_coll__map">
|
|
<area shape="rect" title="Sends a message to all peers." alt="" coords="1019,119,1169,145"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="767,112,937,152"/>
|
|
<area shape="poly" title=" " alt="" coords="951,129,1018,129,1018,135,951,135"/>
|
|
<area shape="rect" href="classripple_1_1Message.html" title=" " alt="" coords="571,119,696,145"/>
|
|
<area shape="poly" title=" " alt="" coords="710,129,767,129,767,135,710,135"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="213,5,392,45"/>
|
|
<area shape="poly" title=" " alt="" coords="407,26,477,36,548,59,591,87,623,117,619,121,588,91,546,64,476,42,406,31"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="219,70,386,95"/>
|
|
<area shape="poly" title=" " alt="" coords="400,90,547,111,578,117,577,122,546,116,399,95"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,70,100,95"/>
|
|
<area shape="poly" title=" " alt="" coords="114,80,219,80,219,85,114,85"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="259,119,347,145"/>
|
|
<area shape="poly" title=" " alt="" coords="360,129,571,129,571,135,360,135"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/once_flag.html" title=" " alt="" coords="247,169,359,194"/>
|
|
<area shape="poly" title=" " alt="" coords="372,172,546,149,581,142,582,147,547,155,373,178"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="225,219,380,259"/>
|
|
<area shape="poly" title=" " alt="" coords="393,226,469,211,546,187,584,166,615,143,618,147,587,170,548,192,470,217,394,232"/>
|
|
</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-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aa23607aafdd78ab88d9a9b18b3581291" id="r_aa23607aafdd78ab88d9a9b18b3581291"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1send__always.html#aa23607aafdd78ab88d9a9b18b3581291">return_type</a> = void</td></tr>
|
|
<tr class="separator:aa23607aafdd78ab88d9a9b18b3581291"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a807c7b37df5293256db2cb8cf6e90dd2" id="r_a807c7b37df5293256db2cb8cf6e90dd2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1send__always.html#a807c7b37df5293256db2cb8cf6e90dd2">send_always</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Message.html">Message</a> > const &m)</td></tr>
|
|
<tr class="separator:a807c7b37df5293256db2cb8cf6e90dd2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2ccac949c1d96b5a4f2796294a4ccd1" id="r_ac2ccac949c1d96b5a4f2796294a4ccd1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1send__always.html#ac2ccac949c1d96b5a4f2796294a4ccd1">operator()</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Peer.html">Peer</a> > const &peer) const</td></tr>
|
|
<tr class="separator:ac2ccac949c1d96b5a4f2796294a4ccd1"><td class="memSeparator" colspan="2"> </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:a0eb78f9fbfc18e45abe26bfb0d1a6c65" id="r_a0eb78f9fbfc18e45abe26bfb0d1a6c65"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Message.html">Message</a> > const & </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1send__always.html#a0eb78f9fbfc18e45abe26bfb0d1a6c65">msg</a></td></tr>
|
|
<tr class="separator:a0eb78f9fbfc18e45abe26bfb0d1a6c65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Sends a message to all peers. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="predicates_8h_source.html#l00031">31</a> of file <a class="el" href="predicates_8h_source.html">predicates.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="aa23607aafdd78ab88d9a9b18b3581291" name="aa23607aafdd78ab88d9a9b18b3581291"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa23607aafdd78ab88d9a9b18b3581291">◆ </a></span>return_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="structripple_1_1send__always.html#aa23607aafdd78ab88d9a9b18b3581291">ripple::send_always::return_type</a> = void</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="predicates_8h_source.html#l00033">33</a> of file <a class="el" href="predicates_8h_source.html">predicates.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a807c7b37df5293256db2cb8cf6e90dd2" name="a807c7b37df5293256db2cb8cf6e90dd2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a807c7b37df5293256db2cb8cf6e90dd2">◆ </a></span>send_always()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::send_always::send_always </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Message.html">Message</a> > const & </td>
|
|
<td class="paramname"><em>m</em></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#l00037">37</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="ac2ccac949c1d96b5a4f2796294a4ccd1" name="ac2ccac949c1d96b5a4f2796294a4ccd1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2ccac949c1d96b5a4f2796294a4ccd1">◆ </a></span>operator()()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::send_always::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>< <a class="el" href="classripple_1_1Peer.html">Peer</a> > const & </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#l00042">42</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="a0eb78f9fbfc18e45abe26bfb0d1a6c65" name="a0eb78f9fbfc18e45abe26bfb0d1a6c65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0eb78f9fbfc18e45abe26bfb0d1a6c65">◆ </a></span>msg</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1Message.html">Message</a>> const& ripple::send_always::msg</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="predicates_8h_source.html#l00035">35</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 <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>
|