mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
239 lines
15 KiB
HTML
239 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::detail::MessageHeader Struct Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1detail.html">detail</a></li><li class="navelem"><a class="el" href="structripple_1_1detail_1_1MessageHeader.html">MessageHeader</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structripple_1_1detail_1_1MessageHeader-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::detail::MessageHeader Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="ProtocolMessage_8h_source.html">ProtocolMessage.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::detail::MessageHeader:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="structripple_1_1detail_1_1MessageHeader__coll__graph.png" border="0" usemap="#aripple_1_1detail_1_1MessageHeader_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1detail_1_1MessageHeader_coll__map" id="aripple_1_1detail_1_1MessageHeader_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="28,137,245,163"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,5,108,31"/>
|
|
<area shape="poly" title=" " alt="" coords="53,44,50,78,53,96,60,112,73,125,90,135,88,140,70,130,56,115,48,97,45,79,48,44"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="165,5,268,31"/>
|
|
<area shape="poly" title=" " alt="" coords="216,45,207,80,190,115,176,129,161,139,158,135,173,125,185,112,202,78,211,44"/>
|
|
</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-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:aa32dae02348b79cc96dfdd0172b0986c" id="r_aa32dae02348b79cc96dfdd0172b0986c"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1detail_1_1MessageHeader.html#aa32dae02348b79cc96dfdd0172b0986c">total_wire_size</a> = 0</td></tr>
|
|
<tr class="memdesc:aa32dae02348b79cc96dfdd0172b0986c"><td class="mdescLeft"> </td><td class="mdescRight">The size of the message on the wire. <br /></td></tr>
|
|
<tr class="separator:aa32dae02348b79cc96dfdd0172b0986c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21a887236c3811e687cd901c6afaf7f6" id="r_a21a887236c3811e687cd901c6afaf7f6"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1detail_1_1MessageHeader.html#a21a887236c3811e687cd901c6afaf7f6">header_size</a> = 0</td></tr>
|
|
<tr class="memdesc:a21a887236c3811e687cd901c6afaf7f6"><td class="mdescLeft"> </td><td class="mdescRight">The size of the header associated with this message. <br /></td></tr>
|
|
<tr class="separator:a21a887236c3811e687cd901c6afaf7f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99f21dbc5ff1d473f488cfcfdf3f07de" id="r_a99f21dbc5ff1d473f488cfcfdf3f07de"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1detail_1_1MessageHeader.html#a99f21dbc5ff1d473f488cfcfdf3f07de">payload_wire_size</a> = 0</td></tr>
|
|
<tr class="memdesc:a99f21dbc5ff1d473f488cfcfdf3f07de"><td class="mdescLeft"> </td><td class="mdescRight">The size of the payload on the wire. <br /></td></tr>
|
|
<tr class="separator:a99f21dbc5ff1d473f488cfcfdf3f07de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af05f9cbdb86061e41cf198a3bdbf46b8" id="r_af05f9cbdb86061e41cf198a3bdbf46b8"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1detail_1_1MessageHeader.html#af05f9cbdb86061e41cf198a3bdbf46b8">uncompressed_size</a> = 0</td></tr>
|
|
<tr class="memdesc:af05f9cbdb86061e41cf198a3bdbf46b8"><td class="mdescLeft"> </td><td class="mdescRight">Uncompressed message size if the message is compressed. <br /></td></tr>
|
|
<tr class="separator:af05f9cbdb86061e41cf198a3bdbf46b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90b9e0938ab622359fbee6d062a9a4ba" id="r_a90b9e0938ab622359fbee6d062a9a4ba"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1detail_1_1MessageHeader.html#a90b9e0938ab622359fbee6d062a9a4ba">message_type</a> = 0</td></tr>
|
|
<tr class="memdesc:a90b9e0938ab622359fbee6d062a9a4ba"><td class="mdescLeft"> </td><td class="mdescRight">The type of the message. <br /></td></tr>
|
|
<tr class="separator:a90b9e0938ab622359fbee6d062a9a4ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2adc0e62ab9e122ec22ba1b137938a1e" id="r_a2adc0e62ab9e122ec22ba1b137938a1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">compression::Algorithm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1detail_1_1MessageHeader.html#a2adc0e62ab9e122ec22ba1b137938a1e">algorithm</a> = <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605ba6adf97f83acf6453d4a6a4b1070f3754">compression::Algorithm::None</a></td></tr>
|
|
<tr class="memdesc:a2adc0e62ab9e122ec22ba1b137938a1e"><td class="mdescLeft"> </td><td class="mdescRight">Indicates which compression algorithm the payload is compressed with. <br /></td></tr>
|
|
<tr class="separator:a2adc0e62ab9e122ec22ba1b137938a1e"><td class="memSeparator" colspan="2"> </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="ProtocolMessage_8h_source.html#l00096">96</a> of file <a class="el" href="ProtocolMessage_8h_source.html">ProtocolMessage.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="aa32dae02348b79cc96dfdd0172b0986c" name="aa32dae02348b79cc96dfdd0172b0986c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa32dae02348b79cc96dfdd0172b0986c">◆ </a></span>total_wire_size</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/integer.html">std::uint32_t</a> ripple::detail::MessageHeader::total_wire_size = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The size of the message on the wire. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This is the sum of sizes of the header and the payload. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ProtocolMessage_8h_source.html#l00102">102</a> of file <a class="el" href="ProtocolMessage_8h_source.html">ProtocolMessage.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21a887236c3811e687cd901c6afaf7f6" name="a21a887236c3811e687cd901c6afaf7f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21a887236c3811e687cd901c6afaf7f6">◆ </a></span>header_size</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/integer.html">std::uint32_t</a> ripple::detail::MessageHeader::header_size = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The size of the header associated with this message. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ProtocolMessage_8h_source.html#l00105">105</a> of file <a class="el" href="ProtocolMessage_8h_source.html">ProtocolMessage.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99f21dbc5ff1d473f488cfcfdf3f07de" name="a99f21dbc5ff1d473f488cfcfdf3f07de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99f21dbc5ff1d473f488cfcfdf3f07de">◆ </a></span>payload_wire_size</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/integer.html">std::uint32_t</a> ripple::detail::MessageHeader::payload_wire_size = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The size of the payload on the wire. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ProtocolMessage_8h_source.html#l00108">108</a> of file <a class="el" href="ProtocolMessage_8h_source.html">ProtocolMessage.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af05f9cbdb86061e41cf198a3bdbf46b8" name="af05f9cbdb86061e41cf198a3bdbf46b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af05f9cbdb86061e41cf198a3bdbf46b8">◆ </a></span>uncompressed_size</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/integer.html">std::uint32_t</a> ripple::detail::MessageHeader::uncompressed_size = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Uncompressed message size if the message is compressed. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ProtocolMessage_8h_source.html#l00111">111</a> of file <a class="el" href="ProtocolMessage_8h_source.html">ProtocolMessage.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90b9e0938ab622359fbee6d062a9a4ba" name="a90b9e0938ab622359fbee6d062a9a4ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90b9e0938ab622359fbee6d062a9a4ba">◆ </a></span>message_type</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/integer.html">std::uint16_t</a> ripple::detail::MessageHeader::message_type = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The type of the message. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ProtocolMessage_8h_source.html#l00114">114</a> of file <a class="el" href="ProtocolMessage_8h_source.html">ProtocolMessage.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2adc0e62ab9e122ec22ba1b137938a1e" name="a2adc0e62ab9e122ec22ba1b137938a1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2adc0e62ab9e122ec22ba1b137938a1e">◆ </a></span>algorithm</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">compression::Algorithm</a> ripple::detail::MessageHeader::algorithm = <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605ba6adf97f83acf6453d4a6a4b1070f3754">compression::Algorithm::None</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Indicates which compression algorithm the payload is compressed with. </p>
|
|
<p>Currenly only lz4 is supported. If None then the message is not compressed. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ProtocolMessage_8h_source.html#l00120">120</a> of file <a class="el" href="ProtocolMessage_8h_source.html">ProtocolMessage.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|