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/Message_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

216 lines
30 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: Message.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c4f38cd849aa2a8e7280b7c5f705957a.html">overlay</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Message.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_OVERLAY_MESSAGE_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_OVERLAY_MESSAGE_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/overlay/Compression.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/basics/ByteUtilities.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/protocol/PublicKey.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;xrpl/protocol/messages.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a>&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="namespaceripple.html#ac6313681c41516db0a8f8829e1d7b753"> 15</a></span><span class="keyword">constexpr</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code hl_variable" href="namespaceripple.html#ac6313681c41516db0a8f8829e1d7b753">maximiumMessageSize</a> = <a class="code hl_function" href="namespaceripple.html#a13d7c6c34d30731bbc221f629e03f8db">megabytes</a>(64);</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">// VFALCO NOTE If we forward declare Message and write out shared_ptr</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// instead of using the in-class type alias, we can remove the</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">// entire ripple.pb.h from the main headers.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">//</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">// packaging of messages into length/type-prepended buffers</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">// ready for transmission.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">//</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">// Message implements simple &quot;packing&quot; of protocol buffers Messages into</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">// a string prepended by a header specifying the message length.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">// MessageType should be a Message class generated by the protobuf compiler.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">//</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html"> 30</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1Message.html">Message</a> : <span class="keyword">public</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html">std::enable_shared_from_this</a>&lt;Message&gt;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a2988842a363a695d1243861b13dd04bf"> 32</a></span> <span class="keyword">using </span><a class="code hl_enumeration" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">Compressed</a> = <a class="code hl_enumeration" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">compression::Compressed</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a917c83b8aebb0fd9448cd08d319cf9d7"> 33</a></span> <span class="keyword">using </span><a class="code hl_enumeration" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a> = <a class="code hl_enumeration" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">compression::Algorithm</a>;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="classripple_1_1Message.html">Message</a>(</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> ::google::protobuf::Message <span class="keyword">const</span>&amp; message,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> protocol::MessageType type,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;PublicKey&gt;</a> <span class="keyword">const</span>&amp; validator = {});</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_function" href="classripple_1_1Message.html#a6e14d9326c8907aac58a5de4668c5840">getBufferSize</a>();</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_function" href="classripple_1_1Message.html#adfda2892c626409bcbf86440c2c0b0e9">messageSize</a>(::google::protobuf::Message <span class="keyword">const</span>&amp; message);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <a class="code hl_function" href="classripple_1_1Message.html#a7a4b11ee88a462956cab12969e833fbe">totalSize</a>(::google::protobuf::Message <span class="keyword">const</span>&amp; message);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;uint8_t&gt;</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <a class="code hl_function" href="classripple_1_1Message.html#a59548b6f1be088035f2858fae9eda66b">getBuffer</a>(<a class="code hl_typedef" href="classripple_1_1Message.html#a2988842a363a695d1243861b13dd04bf">Compressed</a> tryCompressed);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
<div class="foldopen" id="foldopen00068" data-start="{" data-end="}">
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a274fe4c9990f5d9f6d4882ba3c22f1fb"> 68</a></span> <a class="code hl_function" href="classripple_1_1Message.html#a274fe4c9990f5d9f6d4882ba3c22f1fb">getCategory</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1Message.html#a0b12f602dfea3a708efc0b0138a0c510">category_</a>;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;PublicKey&gt;</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00075" data-start="{" data-end="}">
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a78b9737934d2546b3da28b1b58f6702a"> 75</a></span> <a class="code hl_function" href="classripple_1_1Message.html#a78b9737934d2546b3da28b1b58f6702a">getValidatorKey</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1Message.html#a8fcf12040171db67a08cc9387cbeaa1d">validatorKey_</a>;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> }</div>
</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a93709e66e26eb29574a1b5dbcaabf9b6"> 81</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;uint8_t&gt;</a> <a class="code hl_variable" href="classripple_1_1Message.html#a93709e66e26eb29574a1b5dbcaabf9b6">buffer_</a>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#aa1f750b5736b4a641b5d279a2d05ba6f"> 82</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;uint8_t&gt;</a> <a class="code hl_variable" href="classripple_1_1Message.html#aa1f750b5736b4a641b5d279a2d05ba6f">bufferCompressed_</a>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a0b12f602dfea3a708efc0b0138a0c510"> 83</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code hl_variable" href="classripple_1_1Message.html#a0b12f602dfea3a708efc0b0138a0c510">category_</a>;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a15306c929310abec214884a9af5b248d"> 84</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/once_flag.html">std::once_flag</a> <a class="code hl_variable" href="classripple_1_1Message.html#a15306c929310abec214884a9af5b248d">once_flag_</a>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a8fcf12040171db67a08cc9387cbeaa1d"> 85</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;PublicKey&gt;</a> <a class="code hl_variable" href="classripple_1_1Message.html#a8fcf12040171db67a08cc9387cbeaa1d">validatorKey_</a>;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_function" href="classripple_1_1Message.html#a53f6b565ba4f354eeb13f01dbd041848">setHeader</a>(</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a>* <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> payloadBytes,</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">int</span> type,</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <a class="code hl_enumeration" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a> compression,</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> uncompressedBytes);</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <a class="code hl_function" href="classripple_1_1Message.html#ad34a23eec4049e1e4206ad6dbb4e3c8d">compress</a>();</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">int</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <a class="code hl_function" href="classripple_1_1Message.html#aad24b93cd0c33a28c370a91d1e7ffbba">getType</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> <span class="keyword">const</span>* <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>};</div>
</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aalgorithm_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html"><div class="ttname"><a href="classripple_1_1Message.html">ripple::Message</a></div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00030">Message.h:31</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a0b12f602dfea3a708efc0b0138a0c510"><div class="ttname"><a href="classripple_1_1Message.html#a0b12f602dfea3a708efc0b0138a0c510">ripple::Message::category_</a></div><div class="ttdeci">std::size_t category_</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00083">Message.h:83</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a15306c929310abec214884a9af5b248d"><div class="ttname"><a href="classripple_1_1Message.html#a15306c929310abec214884a9af5b248d">ripple::Message::once_flag_</a></div><div class="ttdeci">std::once_flag once_flag_</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00084">Message.h:84</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a274fe4c9990f5d9f6d4882ba3c22f1fb"><div class="ttname"><a href="classripple_1_1Message.html#a274fe4c9990f5d9f6d4882ba3c22f1fb">ripple::Message::getCategory</a></div><div class="ttdeci">std::size_t getCategory() const</div><div class="ttdoc">Get the traffic category.</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00068">Message.h:68</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a2988842a363a695d1243861b13dd04bf"><div class="ttname"><a href="classripple_1_1Message.html#a2988842a363a695d1243861b13dd04bf">ripple::Message::Compressed</a></div><div class="ttdeci">compression::Compressed Compressed</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00032">Message.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a53f6b565ba4f354eeb13f01dbd041848"><div class="ttname"><a href="classripple_1_1Message.html#a53f6b565ba4f354eeb13f01dbd041848">ripple::Message::setHeader</a></div><div class="ttdeci">void setHeader(std::uint8_t *in, std::uint32_t payloadBytes, int type, Algorithm compression, std::uint32_t uncompressedBytes)</div><div class="ttdoc">Set the payload header.</div><div class="ttdef"><b>Definition</b> <a href="Message_8cpp_source.html#l00155">Message.cpp:155</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a59548b6f1be088035f2858fae9eda66b"><div class="ttname"><a href="classripple_1_1Message.html#a59548b6f1be088035f2858fae9eda66b">ripple::Message::getBuffer</a></div><div class="ttdeci">std::vector&lt; uint8_t &gt; const &amp; getBuffer(Compressed tryCompressed)</div><div class="ttdoc">Retrieve the packed message data.</div><div class="ttdef"><b>Definition</b> <a href="Message_8cpp_source.html#l00191">Message.cpp:191</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a6e14d9326c8907aac58a5de4668c5840"><div class="ttname"><a href="classripple_1_1Message.html#a6e14d9326c8907aac58a5de4668c5840">ripple::Message::getBufferSize</a></div><div class="ttdeci">std::size_t getBufferSize()</div><div class="ttdoc">Retrieve the size of the packed but uncompressed message data.</div><div class="ttdef"><b>Definition</b> <a href="Message_8cpp_source.html#l00185">Message.cpp:185</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a78b9737934d2546b3da28b1b58f6702a"><div class="ttname"><a href="classripple_1_1Message.html#a78b9737934d2546b3da28b1b58f6702a">ripple::Message::getValidatorKey</a></div><div class="ttdeci">std::optional&lt; PublicKey &gt; const &amp; getValidatorKey() const</div><div class="ttdoc">Get the validator's key.</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00075">Message.h:75</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a7a4b11ee88a462956cab12969e833fbe"><div class="ttname"><a href="classripple_1_1Message.html#a7a4b11ee88a462956cab12969e833fbe">ripple::Message::totalSize</a></div><div class="ttdeci">static std::size_t totalSize(::google::protobuf::Message const &amp;message)</div><div class="ttdef"><b>Definition</b> <a href="Message_8cpp_source.html#l00047">Message.cpp:47</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a8fcf12040171db67a08cc9387cbeaa1d"><div class="ttname"><a href="classripple_1_1Message.html#a8fcf12040171db67a08cc9387cbeaa1d">ripple::Message::validatorKey_</a></div><div class="ttdeci">std::optional&lt; PublicKey &gt; validatorKey_</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00085">Message.h:85</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_a93709e66e26eb29574a1b5dbcaabf9b6"><div class="ttname"><a href="classripple_1_1Message.html#a93709e66e26eb29574a1b5dbcaabf9b6">ripple::Message::buffer_</a></div><div class="ttdeci">std::vector&lt; uint8_t &gt; buffer_</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00081">Message.h:81</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_aa1f750b5736b4a641b5d279a2d05ba6f"><div class="ttname"><a href="classripple_1_1Message.html#aa1f750b5736b4a641b5d279a2d05ba6f">ripple::Message::bufferCompressed_</a></div><div class="ttdeci">std::vector&lt; uint8_t &gt; bufferCompressed_</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00082">Message.h:82</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_aad24b93cd0c33a28c370a91d1e7ffbba"><div class="ttname"><a href="classripple_1_1Message.html#aad24b93cd0c33a28c370a91d1e7ffbba">ripple::Message::getType</a></div><div class="ttdeci">int getType(std::uint8_t const *in) const</div><div class="ttdoc">Get the message type from the payload header.</div><div class="ttdef"><b>Definition</b> <a href="Message_8cpp_source.html#l00205">Message.cpp:205</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_ad34a23eec4049e1e4206ad6dbb4e3c8d"><div class="ttname"><a href="classripple_1_1Message.html#ad34a23eec4049e1e4206ad6dbb4e3c8d">ripple::Message::compress</a></div><div class="ttdeci">void compress()</div><div class="ttdoc">Try to compress the payload.</div><div class="ttdef"><b>Definition</b> <a href="Message_8cpp_source.html#l00053">Message.cpp:53</a></div></div>
<div class="ttc" id="aclassripple_1_1Message_html_adfda2892c626409bcbf86440c2c0b0e9"><div class="ttname"><a href="classripple_1_1Message.html#adfda2892c626409bcbf86440c2c0b0e9">ripple::Message::messageSize</a></div><div class="ttdeci">static std::size_t messageSize(::google::protobuf::Message const &amp;message)</div><div class="ttdef"><b>Definition</b> <a href="Message_8cpp_source.html#l00036">Message.cpp:36</a></div></div>
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
<div class="ttc" id="aenable_shared_from_this_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html">std::enable_shared_from_this</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a></div></div>
<div class="ttc" id="anamespaceripple_1_1compression_html_a63d59b12f7e712c378860771ef3fdf5f"><div class="ttname"><a href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">ripple::compression::Compressed</a></div><div class="ttdeci">Compressed</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00018">Compression.h:18</a></div></div>
<div class="ttc" id="anamespaceripple_1_1compression_html_ac4e4ca1236f472d7e218c3f69cd8605b"><div class="ttname"><a href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">ripple::compression::Algorithm</a></div><div class="ttdeci">Algorithm</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00016">Compression.h:16</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a13d7c6c34d30731bbc221f629e03f8db"><div class="ttname"><a href="namespaceripple.html#a13d7c6c34d30731bbc221f629e03f8db">ripple::megabytes</a></div><div class="ttdeci">constexpr auto megabytes(T value) noexcept</div><div class="ttdef"><b>Definition</b> <a href="ByteUtilities_8h_source.html#l00015">ByteUtilities.h:15</a></div></div>
<div class="ttc" id="anamespaceripple_html_a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf"><div class="ttname"><a href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">ripple::QualityDirection::in</a></div><div class="ttdeci">@ in</div></div>
<div class="ttc" id="anamespaceripple_html_ac6313681c41516db0a8f8829e1d7b753"><div class="ttname"><a href="namespaceripple.html#ac6313681c41516db0a8f8829e1d7b753">ripple::maximiumMessageSize</a></div><div class="ttdeci">constexpr std::size_t maximiumMessageSize</div><div class="ttdef"><b>Definition</b> <a href="Message_8h_source.html#l00015">Message.h:15</a></div></div>
<div class="ttc" id="aonce_flag_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/once_flag.html">std::once_flag</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a></div></div>
<div class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></div></div>
</div><!-- fragment --></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