ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1BookListeners.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

316 lines
18 KiB
HTML
Raw Permalink Blame History

<!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::BookListeners 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 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="classripple_1_1BookListeners.html">BookListeners</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1BookListeners-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::BookListeners Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Listen to public/subscribe messages from a book.
<a href="classripple_1_1BookListeners.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="BookListeners_8h_source.html">BookListeners.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::BookListeners:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1BookListeners__coll__graph.png" border="0" usemap="#aripple_1_1BookListeners_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1BookListeners_coll__map" id="aripple_1_1BookListeners_coll__map">
<area shape="rect" title="Listen to public/subscribe messages from a book." alt="" coords="44,299,203,324"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="5,196,164,221"/>
<area shape="poly" title=" " alt="" coords="96,233,121,298,116,300,92,235"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="189,181,341,236"/>
<area shape="poly" title=" " alt="" coords="218,246,141,301,138,296,215,242"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="160,93,263,119"/>
<area shape="poly" title=" " alt="" coords="226,129,253,180,248,182,221,132"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html" title=" " alt="" coords="287,93,435,119"/>
<area shape="poly" title=" " alt="" coords="342,131,292,183,288,179,338,127"/>
<area shape="rect" title=" " alt="" coords="341,5,380,31"/>
<area shape="poly" title=" " alt="" coords="363,45,363,93,358,93,358,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-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa461e7d0d1dddc38cc59e1ded621638d" id="r_aa461e7d0d1dddc38cc59e1ded621638d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookListeners.html#aa461e7d0d1dddc38cc59e1ded621638d">pointer</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_1BookListeners.html">BookListeners</a> &gt;</td></tr>
<tr class="separator:aa461e7d0d1dddc38cc59e1ded621638d"><td class="memSeparator" colspan="2">&#160;</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:abef13456e6335190b5d1e814b6838bd4" id="r_abef13456e6335190b5d1e814b6838bd4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookListeners.html#abef13456e6335190b5d1e814b6838bd4">BookListeners</a> ()</td></tr>
<tr class="separator:abef13456e6335190b5d1e814b6838bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d7f4c227a690e895b952472a4202ca1" id="r_a5d7f4c227a690e895b952472a4202ca1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookListeners.html#a5d7f4c227a690e895b952472a4202ca1">addSubscriber</a> (<a class="el" href="classripple_1_1InfoSub.html#ac6cfc7e469ccecc49649e98753af37ea">InfoSub::ref</a> sub)</td></tr>
<tr class="memdesc:a5d7f4c227a690e895b952472a4202ca1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new subscription for this book. <br /></td></tr>
<tr class="separator:a5d7f4c227a690e895b952472a4202ca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53dad68c41be892909cfa1d182b54c39" id="r_a53dad68c41be892909cfa1d182b54c39"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookListeners.html#a53dad68c41be892909cfa1d182b54c39">removeSubscriber</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> sub)</td></tr>
<tr class="memdesc:a53dad68c41be892909cfa1d182b54c39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop publishing to a subscriber. <br /></td></tr>
<tr class="separator:a53dad68c41be892909cfa1d182b54c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace01ee147e463d71092ec8fc84d07eb8" id="r_ace01ee147e463d71092ec8fc84d07eb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookListeners.html#ace01ee147e463d71092ec8fc84d07eb8">publish</a> (<a class="el" href="namespaceripple.html#a0b2d3a5c5dc76d8f261e7b0591771011">MultiApiJson</a> const &amp;jvObj, <a class="el" href="namespaceripple.html#a7750eec5e079354285f1d60cfd0247ca">hash_set</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> &gt; &amp;havePublished)</td></tr>
<tr class="memdesc:ace01ee147e463d71092ec8fc84d07eb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publish a transaction to subscribers. <br /></td></tr>
<tr class="separator:ace01ee147e463d71092ec8fc84d07eb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a18dd8b67ac39506dcf7a980a4b0e250e" id="r_a18dd8b67ac39506dcf7a980a4b0e250e"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookListeners.html#a18dd8b67ac39506dcf7a980a4b0e250e">mLock</a></td></tr>
<tr class="separator:a18dd8b67ac39506dcf7a980a4b0e250e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27f5d2654d8ab4b0ed518c81809b6ebc" id="r_a27f5d2654d8ab4b0ed518c81809b6ebc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a46c521271235f4e2715d7fa8b68940ca">hash_map</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>, <a class="el" href="classripple_1_1InfoSub.html#aaf94a98105c180340881bf6eef915670">InfoSub::wptr</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BookListeners.html#a27f5d2654d8ab4b0ed518c81809b6ebc">mListeners</a></td></tr>
<tr class="separator:a27f5d2654d8ab4b0ed518c81809b6ebc"><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>Listen to public/subscribe messages from a book. </p>
<p class="definition">Definition at line <a class="el" href="BookListeners_8h_source.html#l00014">14</a> of file <a class="el" href="BookListeners_8h_source.html">BookListeners.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="aa461e7d0d1dddc38cc59e1ded621638d" name="aa461e7d0d1dddc38cc59e1ded621638d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa461e7d0d1dddc38cc59e1ded621638d">&#9670;&#160;</a></span>pointer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1BookListeners.html#aa461e7d0d1dddc38cc59e1ded621638d">ripple::BookListeners::pointer</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_1BookListeners.html">BookListeners</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BookListeners_8h_source.html#l00017">17</a> of file <a class="el" href="BookListeners_8h_source.html">BookListeners.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abef13456e6335190b5d1e814b6838bd4" name="abef13456e6335190b5d1e814b6838bd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abef13456e6335190b5d1e814b6838bd4">&#9670;&#160;</a></span>BookListeners()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::BookListeners::BookListeners </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BookListeners_8h_source.html#l00019">19</a> of file <a class="el" href="BookListeners_8h_source.html">BookListeners.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5d7f4c227a690e895b952472a4202ca1" name="a5d7f4c227a690e895b952472a4202ca1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d7f4c227a690e895b952472a4202ca1">&#9670;&#160;</a></span>addSubscriber()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::BookListeners::addSubscriber </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1InfoSub.html#ac6cfc7e469ccecc49649e98753af37ea">InfoSub::ref</a>&#160;</td>
<td class="paramname"><em>sub</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new subscription for this book. </p>
<p class="definition">Definition at line <a class="el" href="BookListeners_8cpp_source.html#l00006">6</a> of file <a class="el" href="BookListeners_8cpp_source.html">BookListeners.cpp</a>.</p>
</div>
</div>
<a id="a53dad68c41be892909cfa1d182b54c39" name="a53dad68c41be892909cfa1d182b54c39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53dad68c41be892909cfa1d182b54c39">&#9670;&#160;</a></span>removeSubscriber()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::BookListeners::removeSubscriber </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td>
<td class="paramname"><em>sub</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop publishing to a subscriber. </p>
<p class="definition">Definition at line <a class="el" href="BookListeners_8cpp_source.html#l00013">13</a> of file <a class="el" href="BookListeners_8cpp_source.html">BookListeners.cpp</a>.</p>
</div>
</div>
<a id="ace01ee147e463d71092ec8fc84d07eb8" name="ace01ee147e463d71092ec8fc84d07eb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace01ee147e463d71092ec8fc84d07eb8">&#9670;&#160;</a></span>publish()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::BookListeners::publish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a0b2d3a5c5dc76d8f261e7b0591771011">MultiApiJson</a> const &amp;&#160;</td>
<td class="paramname"><em>jvObj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a7750eec5e079354285f1d60cfd0247ca">hash_set</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>havePublished</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Publish a transaction to subscribers. </p>
<p>Publish a transaction to clients subscribed to changes on this book. Uses havePublished to prevent sending duplicate transactions to clients that have subscribed to multiple books.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">jvObj</td><td>JSON transaction data to publish </td></tr>
<tr><td class="paramname">havePublished</td><td><a class="el" href="classripple_1_1InfoSub.html" title="Manages a client&#39;s subscription to data feeds.">InfoSub</a> sequence numbers that have already published this transaction. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="BookListeners_8cpp_source.html#l00020">20</a> of file <a class="el" href="BookListeners_8cpp_source.html">BookListeners.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a18dd8b67ac39506dcf7a980a4b0e250e" name="a18dd8b67ac39506dcf7a980a4b0e250e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18dd8b67ac39506dcf7a980a4b0e250e">&#9670;&#160;</a></span>mLock</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a> ripple::BookListeners::mLock</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BookListeners_8h_source.html#l00048">48</a> of file <a class="el" href="BookListeners_8h_source.html">BookListeners.h</a>.</p>
</div>
</div>
<a id="a27f5d2654d8ab4b0ed518c81809b6ebc" name="a27f5d2654d8ab4b0ed518c81809b6ebc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27f5d2654d8ab4b0ed518c81809b6ebc">&#9670;&#160;</a></span>mListeners</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="namespaceripple.html#a46c521271235f4e2715d7fa8b68940ca">hash_map</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>, <a class="el" href="classripple_1_1InfoSub.html#aaf94a98105c180340881bf6eef915670">InfoSub::wptr</a>&gt; ripple::BookListeners::mListeners</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BookListeners_8h_source.html#l00050">50</a> of file <a class="el" href="BookListeners_8h_source.html">BookListeners.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>
Reference in New Issue View Git Blame Copy Permalink