mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-27 06:25:51 +00:00
227 lines
34 KiB
HTML
227 lines
34 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">
|
|
<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.8.17"/>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_b003f5a72efe503c7552f86021e0c4d2.html">overlay</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">overlay/Message.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_OVERLAY_MESSAGE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_OVERLAY_MESSAGE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/basics/ByteUtilities.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/overlay/Compression.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/protocol/PublicKey.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <ripple/protocol/messages.h></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <boost/asio/buffer.hpp></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <boost/asio/buffers_iterator.hpp></span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a>></span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/array.html">array</a>></span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>></span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/iterator.html">iterator</a>></span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>></span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a>></span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespaceripple.html#ac6313681c41516db0a8f8829e1d7b753"> 38</a></span> constexpr <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code" href="namespaceripple.html#ac6313681c41516db0a8f8829e1d7b753">maximiumMessageSize</a> = <a class="code" href="namespaceripple.html#a13d7c6c34d30731bbc221f629e03f8db">megabytes</a>(64);</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// VFALCO NOTE If we forward declare Message and write out shared_ptr</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// instead of using the in-class type alias, we can remove the</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// entire ripple.pb.h from the main headers.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// packaging of messages into length/type-prepended buffers</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// ready for transmission.</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// Message implements simple "packing" of protocol buffers Messages into</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// a string prepended by a header specifying the message length.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// MessageType should be a Message class generated by the protobuf compiler.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html"> 53</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1Message.html">Message</a> : <span class="keyword">public</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html">std::enable_shared_from_this</a><Message></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> {</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a2988842a363a695d1243861b13dd04bf"> 55</a></span>  <span class="keyword">using</span> <a class="code" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">Compressed</a> = <a class="code" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">compression::Compressed</a>;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a917c83b8aebb0fd9448cd08d319cf9d7"> 56</a></span>  <span class="keyword">using</span> <a class="code" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a> = <a class="code" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">compression::Algorithm</a>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classripple_1_1Message.html#a51a8e5f78d38a7bba124be9b7e6019f6">Message</a>(</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  ::google::protobuf::Message <span class="keyword">const</span>& message,</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">int</span> type,</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<PublicKey></a> <span class="keyword">const</span>& validator = {});</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classripple_1_1Message.html#a6e14d9326c8907aac58a5de4668c5840">getBufferSize</a>();</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">static</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classripple_1_1Message.html#adfda2892c626409bcbf86440c2c0b0e9">messageSize</a>(::google::protobuf::Message <span class="keyword">const</span>& message);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">static</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classripple_1_1Message.html#a7a4b11ee88a462956cab12969e833fbe">totalSize</a>(::google::protobuf::Message <span class="keyword">const</span>& message);</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector<uint8_t></a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classripple_1_1Message.html#a59548b6f1be088035f2858fae9eda66b">getBuffer</a>(<a class="code" href="classripple_1_1Message.html#a2988842a363a695d1243861b13dd04bf">Compressed</a> tryCompressed);</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a274fe4c9990f5d9f6d4882ba3c22f1fb"> 91</a></span>  <a class="code" href="classripple_1_1Message.html#a274fe4c9990f5d9f6d4882ba3c22f1fb">getCategory</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1Message.html#a0b12f602dfea3a708efc0b0138a0c510">category_</a>;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<PublicKey></a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a4eecf31aa99d9ec11aead71a02092e1b"> 98</a></span>  <a class="code" href="classripple_1_1Message.html#a4eecf31aa99d9ec11aead71a02092e1b">getValidatorKey</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1Message.html#a8fcf12040171db67a08cc9387cbeaa1d">validatorKey_</a>;</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  }</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a93709e66e26eb29574a1b5dbcaabf9b6"> 104</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector<uint8_t></a> <a class="code" href="classripple_1_1Message.html#a93709e66e26eb29574a1b5dbcaabf9b6">buffer_</a>;</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#aa1f750b5736b4a641b5d279a2d05ba6f"> 105</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector<uint8_t></a> <a class="code" href="classripple_1_1Message.html#aa1f750b5736b4a641b5d279a2d05ba6f">bufferCompressed_</a>;</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a0b12f602dfea3a708efc0b0138a0c510"> 106</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code" href="classripple_1_1Message.html#a0b12f602dfea3a708efc0b0138a0c510">category_</a>;</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a15306c929310abec214884a9af5b248d"> 107</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/once_flag.html">std::once_flag</a> <a class="code" href="classripple_1_1Message.html#a15306c929310abec214884a9af5b248d">once_flag_</a>;</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classripple_1_1Message.html#a8fcf12040171db67a08cc9387cbeaa1d"> 108</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<PublicKey></a> <a class="code" href="classripple_1_1Message.html#a8fcf12040171db67a08cc9387cbeaa1d">validatorKey_</a>;</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classripple_1_1Message.html#a53f6b565ba4f354eeb13f01dbd041848">setHeader</a>(</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a>* in,</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> payloadBytes,</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">int</span> type,</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a> compression,</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> uncompressedBytes);</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="classripple_1_1Message.html#ad34a23eec4049e1e4206ad6dbb4e3c8d">compress</a>();</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">int</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <a class="code" href="classripple_1_1Message.html#aad24b93cd0c33a28c370a91d1e7ffbba">getType</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> <span class="keyword">const</span>* in) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> };</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  </div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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< PublicKey > validatorKey_</div><div class="ttdef"><b>Definition:</b> <a href="overlay_2Message_8h_source.html#l00108">overlay/Message.h:108</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< uint8_t > const & 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#l00210">Message.cpp:210</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#l00068">Message.cpp:68</a></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="overlay_2Message_8h_source.html#l00038">overlay/Message.h:38</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 &message)</div><div class="ttdef"><b>Definition:</b> <a href="Message_8cpp_source.html#l00062">Message.cpp:62</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 &message)</div><div class="ttdef"><b>Definition:</b> <a href="Message_8cpp_source.html#l00051">Message.cpp:51</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< uint8_t ></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#l00224">Message.cpp:224</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#l00174">Message.cpp:174</a></div></div>
|
|
<div class="ttc" id="aiterator_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/iterator.html">iterator</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="overlay_2Message_8h_source.html#l00107">overlay/Message.h:107</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="overlay_2Message_8h_source.html#l00091">overlay/Message.h:91</a></div></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="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="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#l00034">ByteUtilities.h:34</a></div></div>
|
|
<div class="ttc" id="aarray_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/array.html">array</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Message_html_a51a8e5f78d38a7bba124be9b7e6019f6"><div class="ttname"><a href="classripple_1_1Message.html#a51a8e5f78d38a7bba124be9b7e6019f6">ripple::Message::Message</a></div><div class="ttdeci">Message(::google::protobuf::Message const &message, int type, std::optional< PublicKey > const &validator={})</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="Message_8cpp_source.html#l00026">Message.cpp:26</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="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#l00038">Compression.h:38</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="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="overlay_2Message_8h_source.html#l00055">overlay/Message.h:55</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_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#l00036">Compression.h:36</a></div></div>
|
|
<div class="ttc" id="amemory_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/memory.html">memory</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< uint8_t > buffer_</div><div class="ttdef"><b>Definition:</b> <a href="overlay_2Message_8h_source.html#l00104">overlay/Message.h:104</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="overlay_2Message_8h_source.html#l00053">overlay/Message.h:53</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#l00204">Message.cpp:204</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</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< uint8_t > bufferCompressed_</div><div class="ttdef"><b>Definition:</b> <a href="overlay_2Message_8h_source.html#l00105">overlay/Message.h:105</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="aclassripple_1_1Message_html_a4eecf31aa99d9ec11aead71a02092e1b"><div class="ttname"><a href="classripple_1_1Message.html#a4eecf31aa99d9ec11aead71a02092e1b">ripple::Message::getValidatorKey</a></div><div class="ttdeci">std::optional< PublicKey > const & getValidatorKey() const</div><div class="ttdoc">Get the validator's key.</div><div class="ttdef"><b>Definition:</b> <a href="overlay_2Message_8h_source.html#l00098">overlay/Message.h:98</a></div></div>
|
|
<div class="ttc" id="atype_traits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</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="overlay_2Message_8h_source.html#l00106">overlay/Message.h:106</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|