ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/classripple_1_1Message.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

708 lines
40 KiB
HTML
Raw 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::Message 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_1Message.html">Message</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1Message-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Message Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Message_8h_source.html">Message.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::Message:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Message__inherit__graph.png" border="0" usemap="#aripple_1_1Message_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1Message_inherit__map" id="aripple_1_1Message_inherit__map">
<area shape="rect" title=" " alt="" coords="32,93,157,119"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="5,5,184,45"/>
<area shape="poly" title=" " alt="" coords="97,59,97,93,92,93,92,59"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::Message:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Message__coll__graph.png" border="0" usemap="#aripple_1_1Message_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1Message_coll__map" id="aripple_1_1Message_coll__map">
<area shape="rect" title=" " alt="" coords="571,119,696,145"/>
<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-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a91876bd951318278fe177bcfb7574d73" id="r_a91876bd951318278fe177bcfb7574d73"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a91876bd951318278fe177bcfb7574d73">Message</a> (::google::protobuf::Message const &amp;message, protocol::MessageType type, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> &gt; const &amp;validator={})</td></tr>
<tr class="memdesc:a91876bd951318278fe177bcfb7574d73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a91876bd951318278fe177bcfb7574d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e14d9326c8907aac58a5de4668c5840" id="r_a6e14d9326c8907aac58a5de4668c5840"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a6e14d9326c8907aac58a5de4668c5840">getBufferSize</a> ()</td></tr>
<tr class="memdesc:a6e14d9326c8907aac58a5de4668c5840"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the size of the packed but uncompressed message data. <br /></td></tr>
<tr class="separator:a6e14d9326c8907aac58a5de4668c5840"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59548b6f1be088035f2858fae9eda66b" id="r_a59548b6f1be088035f2858fae9eda66b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; uint8_t &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a59548b6f1be088035f2858fae9eda66b">getBuffer</a> (<a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">Compressed</a> tryCompressed)</td></tr>
<tr class="memdesc:a59548b6f1be088035f2858fae9eda66b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the packed message data. <br /></td></tr>
<tr class="separator:a59548b6f1be088035f2858fae9eda66b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a274fe4c9990f5d9f6d4882ba3c22f1fb" id="r_a274fe4c9990f5d9f6d4882ba3c22f1fb"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a274fe4c9990f5d9f6d4882ba3c22f1fb">getCategory</a> () const</td></tr>
<tr class="memdesc:a274fe4c9990f5d9f6d4882ba3c22f1fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the traffic category. <br /></td></tr>
<tr class="separator:a274fe4c9990f5d9f6d4882ba3c22f1fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78b9737934d2546b3da28b1b58f6702a" id="r_a78b9737934d2546b3da28b1b58f6702a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a78b9737934d2546b3da28b1b58f6702a">getValidatorKey</a> () const</td></tr>
<tr class="memdesc:a78b9737934d2546b3da28b1b58f6702a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the validator's key. <br /></td></tr>
<tr class="separator:a78b9737934d2546b3da28b1b58f6702a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this/shared_from_this.html">shared_from_this</a> (T... args)</td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this/weak_from_this.html">weak_from_this</a> (T... args)</td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:adfda2892c626409bcbf86440c2c0b0e9" id="r_adfda2892c626409bcbf86440c2c0b0e9"><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#adfda2892c626409bcbf86440c2c0b0e9">messageSize</a> (::google::protobuf::Message const &amp;message)</td></tr>
<tr class="separator:adfda2892c626409bcbf86440c2c0b0e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a4b11ee88a462956cab12969e833fbe" id="r_a7a4b11ee88a462956cab12969e833fbe"><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a7a4b11ee88a462956cab12969e833fbe">totalSize</a> (::google::protobuf::Message const &amp;message)</td></tr>
<tr class="separator:a7a4b11ee88a462956cab12969e833fbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a2988842a363a695d1243861b13dd04bf" id="r_a2988842a363a695d1243861b13dd04bf"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a2988842a363a695d1243861b13dd04bf">Compressed</a> = <a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">compression::Compressed</a></td></tr>
<tr class="separator:a2988842a363a695d1243861b13dd04bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a917c83b8aebb0fd9448cd08d319cf9d7" id="r_a917c83b8aebb0fd9448cd08d319cf9d7"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a917c83b8aebb0fd9448cd08d319cf9d7">Algorithm</a> = <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">compression::Algorithm</a></td></tr>
<tr class="separator:a917c83b8aebb0fd9448cd08d319cf9d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a53f6b565ba4f354eeb13f01dbd041848" id="r_a53f6b565ba4f354eeb13f01dbd041848"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a53f6b565ba4f354eeb13f01dbd041848">setHeader</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> *<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> payloadBytes, int type, <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a> compression, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> uncompressedBytes)</td></tr>
<tr class="memdesc:a53f6b565ba4f354eeb13f01dbd041848"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the payload header. <br /></td></tr>
<tr class="separator:a53f6b565ba4f354eeb13f01dbd041848"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad34a23eec4049e1e4206ad6dbb4e3c8d" id="r_ad34a23eec4049e1e4206ad6dbb4e3c8d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#ad34a23eec4049e1e4206ad6dbb4e3c8d">compress</a> ()</td></tr>
<tr class="memdesc:ad34a23eec4049e1e4206ad6dbb4e3c8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to compress the payload. <br /></td></tr>
<tr class="separator:ad34a23eec4049e1e4206ad6dbb4e3c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad24b93cd0c33a28c370a91d1e7ffbba" id="r_aad24b93cd0c33a28c370a91d1e7ffbba"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#aad24b93cd0c33a28c370a91d1e7ffbba">getType</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> const *<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>) const</td></tr>
<tr class="memdesc:aad24b93cd0c33a28c370a91d1e7ffbba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the message type from the payload header. <br /></td></tr>
<tr class="separator:aad24b93cd0c33a28c370a91d1e7ffbba"><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:a93709e66e26eb29574a1b5dbcaabf9b6" id="r_a93709e66e26eb29574a1b5dbcaabf9b6"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a93709e66e26eb29574a1b5dbcaabf9b6">buffer_</a></td></tr>
<tr class="separator:a93709e66e26eb29574a1b5dbcaabf9b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1f750b5736b4a641b5d279a2d05ba6f" id="r_aa1f750b5736b4a641b5d279a2d05ba6f"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#aa1f750b5736b4a641b5d279a2d05ba6f">bufferCompressed_</a></td></tr>
<tr class="separator:aa1f750b5736b4a641b5d279a2d05ba6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b12f602dfea3a708efc0b0138a0c510" id="r_a0b12f602dfea3a708efc0b0138a0c510"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a0b12f602dfea3a708efc0b0138a0c510">category_</a></td></tr>
<tr class="separator:a0b12f602dfea3a708efc0b0138a0c510"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15306c929310abec214884a9af5b248d" id="r_a15306c929310abec214884a9af5b248d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/once_flag.html">std::once_flag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a15306c929310abec214884a9af5b248d">once_flag_</a></td></tr>
<tr class="separator:a15306c929310abec214884a9af5b248d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fcf12040171db67a08cc9387cbeaa1d" id="r_a8fcf12040171db67a08cc9387cbeaa1d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Message.html#a8fcf12040171db67a08cc9387cbeaa1d">validatorKey_</a></td></tr>
<tr class="separator:a8fcf12040171db67a08cc9387cbeaa1d"><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 class="definition">Definition at line <a class="el" href="Message_8h_source.html#l00049">49</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a2988842a363a695d1243861b13dd04bf" name="a2988842a363a695d1243861b13dd04bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2988842a363a695d1243861b13dd04bf">&#9670;&#160;</a></span>Compressed</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">ripple::Message::Compressed</a> = <a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">compression::Compressed</a></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="Message_8h_source.html#l00051">51</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div>
</div>
<a id="a917c83b8aebb0fd9448cd08d319cf9d7" name="a917c83b8aebb0fd9448cd08d319cf9d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a917c83b8aebb0fd9448cd08d319cf9d7">&#9670;&#160;</a></span>Algorithm</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">ripple::Message::Algorithm</a> = <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">compression::Algorithm</a></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="Message_8h_source.html#l00052">52</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a91876bd951318278fe177bcfb7574d73" name="a91876bd951318278fe177bcfb7574d73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91876bd951318278fe177bcfb7574d73">&#9670;&#160;</a></span>Message()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Message::Message </td>
<td>(</td>
<td class="paramtype">::google::protobuf::Message const &amp;&#160;</td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">protocol::MessageType&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>validator</em> = <code>{}</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>Protocol message to serialize </td></tr>
<tr><td class="paramname">type</td><td>Protocol message type </td></tr>
<tr><td class="paramname">validator</td><td>Public Key of the source validator for Validation or Proposal message. Used to check if the message should be squelched. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="Message_8cpp_source.html#l00027">27</a> of file <a class="el" href="Message_8cpp_source.html">Message.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6e14d9326c8907aac58a5de4668c5840" name="a6e14d9326c8907aac58a5de4668c5840"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e14d9326c8907aac58a5de4668c5840">&#9670;&#160;</a></span>getBufferSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::Message::getBufferSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the size of the packed but uncompressed message data. </p>
<p class="definition">Definition at line <a class="el" href="Message_8cpp_source.html#l00204">204</a> of file <a class="el" href="Message_8cpp_source.html">Message.cpp</a>.</p>
</div>
</div>
<a id="adfda2892c626409bcbf86440c2c0b0e9" name="adfda2892c626409bcbf86440c2c0b0e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfda2892c626409bcbf86440c2c0b0e9">&#9670;&#160;</a></span>messageSize()</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/types/size_t.html">std::size_t</a> ripple::Message::messageSize </td>
<td>(</td>
<td class="paramtype">::google::protobuf::Message const &amp;&#160;</td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Message_8cpp_source.html#l00055">55</a> of file <a class="el" href="Message_8cpp_source.html">Message.cpp</a>.</p>
</div>
</div>
<a id="a7a4b11ee88a462956cab12969e833fbe" name="a7a4b11ee88a462956cab12969e833fbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a4b11ee88a462956cab12969e833fbe">&#9670;&#160;</a></span>totalSize()</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/types/size_t.html">std::size_t</a> ripple::Message::totalSize </td>
<td>(</td>
<td class="paramtype">::google::protobuf::Message const &amp;&#160;</td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Message_8cpp_source.html#l00066">66</a> of file <a class="el" href="Message_8cpp_source.html">Message.cpp</a>.</p>
</div>
</div>
<a id="a59548b6f1be088035f2858fae9eda66b" name="a59548b6f1be088035f2858fae9eda66b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59548b6f1be088035f2858fae9eda66b">&#9670;&#160;</a></span>getBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; uint8_t &gt; const &amp; ripple::Message::getBuffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">Compressed</a>&#160;</td>
<td class="paramname"><em>tryCompressed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the packed message data. </p>
<p>If compressed message is requested but the message is not compressible then the uncompressed buffer is returned. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">compressed</td><td>Request compressed (Compress::On) or uncompressed (Compress::Off) payload buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Payload buffer </dd></dl>
<p class="definition">Definition at line <a class="el" href="Message_8cpp_source.html#l00210">210</a> of file <a class="el" href="Message_8cpp_source.html">Message.cpp</a>.</p>
</div>
</div>
<a id="a274fe4c9990f5d9f6d4882ba3c22f1fb" name="a274fe4c9990f5d9f6d4882ba3c22f1fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a274fe4c9990f5d9f6d4882ba3c22f1fb">&#9670;&#160;</a></span>getCategory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::Message::getCategory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the traffic category. </p>
<p class="definition">Definition at line <a class="el" href="Message_8h_source.html#l00087">87</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div>
</div>
<a id="a78b9737934d2546b3da28b1b58f6702a" name="a78b9737934d2546b3da28b1b58f6702a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78b9737934d2546b3da28b1b58f6702a">&#9670;&#160;</a></span>getValidatorKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> &gt; const &amp; ripple::Message::getValidatorKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the validator's key. </p>
<p class="definition">Definition at line <a class="el" href="Message_8h_source.html#l00094">94</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div>
</div>
<a id="a53f6b565ba4f354eeb13f01dbd041848" name="a53f6b565ba4f354eeb13f01dbd041848"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53f6b565ba4f354eeb13f01dbd041848">&#9670;&#160;</a></span>setHeader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Message::setHeader </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> *&#160;</td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td>
<td class="paramname"><em>payloadBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a>&#160;</td>
<td class="paramname"><em>compression</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td>
<td class="paramname"><em>uncompressedBytes</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>Set the payload header. </p>
<p>Set payload header.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>Pointer to the payload </td></tr>
<tr><td class="paramname">payloadBytes</td><td>Size of the payload excluding the header size </td></tr>
<tr><td class="paramname">type</td><td>Protocol message type </td></tr>
<tr><td class="paramname">compression</td><td>Compression algorithm used in compression, currently LZ4 only. If None then the message is uncompressed. </td></tr>
<tr><td class="paramname">uncompressedBytes</td><td>Size of the uncompressed message</td></tr>
</table>
</dd>
</dl>
<p>The header is a variable-sized structure that contains information about the type of the message and the length and encoding of the payload.</p>
<p>The first bit determines whether a message is compressed or uncompressed; for compressed messages, the next three bits identify the compression algorithm.</p>
<p>All multi-byte values are represented in big endian.</p>
<p>For uncompressed messages (6 bytes), numbering bits from left to right: </p><pre class="fragment">- The first 6 bits are set to 0.
- The next 26 bits represent the payload size.
- The remaining 16 bits represent the message type.
</pre><p> For compressed messages (10 bytes), numbering bits from left to right: </p><pre class="fragment">- The first 32 bits, together, represent the compression algorithm
and payload size:
- The first bit is set to 1 to indicate the message is compressed.
- The next 3 bits indicate the compression algorithm.
- The next 2 bits are reserved at this time and set to 0.
- The remaining 26 bits represent the payload size.
- The next 16 bits represent the message type.
- The remaining 32 bits are the uncompressed message size.
</pre><p> The maximum size of a message at this time is 64 MB. Messages larger than this will be dropped and the recipient may, at its option, sever the link.</p>
<dl class="section note"><dt>Note</dt><dd>While nominally a part of the wire protocol, the framing is subject to change; future versions of the code may negotiate the use of substantially different framing. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Message_8cpp_source.html#l00174">174</a> of file <a class="el" href="Message_8cpp_source.html">Message.cpp</a>.</p>
</div>
</div>
<a id="ad34a23eec4049e1e4206ad6dbb4e3c8d" name="ad34a23eec4049e1e4206ad6dbb4e3c8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad34a23eec4049e1e4206ad6dbb4e3c8d">&#9670;&#160;</a></span>compress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Message::compress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Try to compress the payload. </p>
<p>Can be called concurrently by multiple peers but is compressed once. If the message is not compressible then the serialized buffer_ is used. </p>
<p class="definition">Definition at line <a class="el" href="Message_8cpp_source.html#l00072">72</a> of file <a class="el" href="Message_8cpp_source.html">Message.cpp</a>.</p>
</div>
</div>
<a id="aad24b93cd0c33a28c370a91d1e7ffbba" name="aad24b93cd0c33a28c370a91d1e7ffbba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad24b93cd0c33a28c370a91d1e7ffbba">&#9670;&#160;</a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ripple::Message::getType </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> const *&#160;</td>
<td class="paramname"><em>in</em></td><td>)</td>
<td> const</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>Get the message type from the payload header. </p>
<p>First four bytes are the compression/algorithm flag and the payload size. Next two bytes are the message type </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>Payload header pointer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Message.html">Message</a> type </dd></dl>
<p class="definition">Definition at line <a class="el" href="Message_8cpp_source.html#l00224">224</a> of file <a class="el" href="Message_8cpp_source.html">Message.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a93709e66e26eb29574a1b5dbcaabf9b6" name="a93709e66e26eb29574a1b5dbcaabf9b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93709e66e26eb29574a1b5dbcaabf9b6">&#9670;&#160;</a></span>buffer_</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/container/vector.html">std::vector</a>&lt;uint8_t&gt; ripple::Message::buffer_</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="Message_8h_source.html#l00100">100</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div>
</div>
<a id="aa1f750b5736b4a641b5d279a2d05ba6f" name="aa1f750b5736b4a641b5d279a2d05ba6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1f750b5736b4a641b5d279a2d05ba6f">&#9670;&#160;</a></span>bufferCompressed_</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/container/vector.html">std::vector</a>&lt;uint8_t&gt; ripple::Message::bufferCompressed_</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="Message_8h_source.html#l00101">101</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div>
</div>
<a id="a0b12f602dfea3a708efc0b0138a0c510" name="a0b12f602dfea3a708efc0b0138a0c510"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b12f602dfea3a708efc0b0138a0c510">&#9670;&#160;</a></span>category_</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/types/size_t.html">std::size_t</a> ripple::Message::category_</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="Message_8h_source.html#l00102">102</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div>
</div>
<a id="a15306c929310abec214884a9af5b248d" name="a15306c929310abec214884a9af5b248d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15306c929310abec214884a9af5b248d">&#9670;&#160;</a></span>once_flag_</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/once_flag.html">std::once_flag</a> ripple::Message::once_flag_</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="Message_8h_source.html#l00103">103</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
</div>
</div>
<a id="a8fcf12040171db67a08cc9387cbeaa1d" name="a8fcf12040171db67a08cc9387cbeaa1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fcf12040171db67a08cc9387cbeaa1d">&#9670;&#160;</a></span>validatorKey_</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/utility/optional.html">std::optional</a>&lt;<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a>&gt; ripple::Message::validatorKey_</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="Message_8h_source.html#l00104">104</a> of file <a class="el" href="Message_8h_source.html">Message.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