mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
deploy: afc05659ed
This commit is contained in:
bthomee
@@ -3,7 +3,7 @@
|
||||
<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.5"/>
|
||||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>rippled: Compression.h Source File</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -29,7 +29,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.5 -->
|
||||
<!-- 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');
|
||||
@@ -46,6 +46,11 @@ $(function() {
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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()"
|
||||
@@ -103,6 +108,7 @@ $(function() {
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
||||
<div class="foldopen" id="foldopen00028" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="namespaceripple_1_1compression.html"> 28</a></span><span class="keyword">namespace </span>compression {</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="namespaceripple_1_1compression.html#a0677d67ee538c34d3b8effde7364de10"> 30</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple_1_1compression.html#a0677d67ee538c34d3b8effde7364de10">headerBytes</a> = 6;</div>
|
||||
@@ -116,6 +122,7 @@ $(function() {
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
|
||||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">template</span> <<span class="keyword">typename</span> InputStream></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="foldopen" id="foldopen00049" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="namespaceripple_1_1compression.html#a65e2ec5e871a86d15892ae7d696a83c9"> 49</a></span><a class="code hl_function" href="namespaceripple_1_1compression.html#a65e2ec5e871a86d15892ae7d696a83c9">decompress</a>(</div>
|
||||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> InputStream& <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>,</div>
|
||||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> inSize,</div>
|
||||
@@ -143,9 +150,11 @@ $(function() {
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> }</div>
|
||||
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
|
||||
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keyword">template</span> <<span class="keyword">class</span> BufferFactory></div>
|
||||
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</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="foldopen00088" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="namespaceripple_1_1compression.html#a566b52accba07f1d57a3b44d2522b146"> 88</a></span><a class="code hl_function" href="namespaceripple_1_1compression.html#a566b52accba07f1d57a3b44d2522b146">compress</a>(</div>
|
||||
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">void</span> <span class="keyword">const</span>* <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>,</div>
|
||||
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> inSize,</div>
|
||||
@@ -156,7 +165,7 @@ $(function() {
|
||||
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> {</div>
|
||||
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">if</span> (algorithm == <a class="code hl_enumvalue" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594">Algorithm::LZ4</a>)</div>
|
||||
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple_1_1compression__algorithms.html#a8fb4610c8381afcf3d92ddfff9dbf0cf">ripple::compression_algorithms::lz4Compress</a>(</div>
|
||||
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>, inSize, std::forward<BufferFactory>(bf));</div>
|
||||
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>, inSize, <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward<BufferFactory></a>(bf));</div>
|
||||
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">else</span></div>
|
||||
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> {</div>
|
||||
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> JLOG(<a class="code hl_function" href="namespaceripple.html#a94e13759bd026c8ac305482e17f05adb">debugLog</a>().warn()) << <span class="stringliteral">"compress: invalid compression algorithm"</span></div>
|
||||
@@ -171,32 +180,35 @@ $(function() {
|
||||
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> }</div>
|
||||
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span>} <span class="comment">// namespace compression</span></div>
|
||||
</div>
|
||||
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
|
||||
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span>} <span class="comment">// namespace ripple</span></div>
|
||||
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
|
||||
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLED_COMPRESSION_H_INCLUDED</span></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__algorithms_html_a8fb4610c8381afcf3d92ddfff9dbf0cf"><div class="ttname"><a href="namespaceripple_1_1compression__algorithms.html#a8fb4610c8381afcf3d92ddfff9dbf0cf">ripple::compression_algorithms::lz4Compress</a></div><div class="ttdeci">std::size_t lz4Compress(void const *in, std::size_t inSize, BufferFactory &&bf)</div><div class="ttdoc">LZ4 block compression.</div><div class="ttdef"><b>Definition:</b> <a href="CompressionAlgorithms_8h_source.html#l00046">CompressionAlgorithms.h:46</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression__algorithms_html_aaac3950d953bd5bf03fdca6e8de0cc85"><div class="ttname"><a href="namespaceripple_1_1compression__algorithms.html#aaac3950d953bd5bf03fdca6e8de0cc85">ripple::compression_algorithms::lz4Decompress</a></div><div class="ttdeci">std::size_t lz4Decompress(std::uint8_t const *in, std::size_t inSizeUnchecked, std::uint8_t *decompressed, std::size_t decompressedSizeUnchecked)</div><div class="ttdef"><b>Definition:</b> <a href="CompressionAlgorithms_8h_source.html#l00076">CompressionAlgorithms.h:76</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a0677d67ee538c34d3b8effde7364de10"><div class="ttname"><a href="namespaceripple_1_1compression.html#a0677d67ee538c34d3b8effde7364de10">ripple::compression::headerBytes</a></div><div class="ttdeci">std::size_t constexpr headerBytes</div><div class="ttdef"><b>Definition:</b> <a href="Compression_8h_source.html#l00030">Compression.h:30</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a566b52accba07f1d57a3b44d2522b146"><div class="ttname"><a href="namespaceripple_1_1compression.html#a566b52accba07f1d57a3b44d2522b146">ripple::compression::compress</a></div><div class="ttdeci">std::size_t compress(void const *in, std::size_t inSize, BufferFactory &&bf, Algorithm algorithm=Algorithm::LZ4)</div><div class="ttdoc">Compress input data.</div><div class="ttdef"><b>Definition:</b> <a href="Compression_8h_source.html#l00088">Compression.h:88</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#l00037">Compression.h:37</a></div></div>
|
||||
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression__algorithms_html_a8fb4610c8381afcf3d92ddfff9dbf0cf"><div class="ttname"><a href="namespaceripple_1_1compression__algorithms.html#a8fb4610c8381afcf3d92ddfff9dbf0cf">ripple::compression_algorithms::lz4Compress</a></div><div class="ttdeci">std::size_t lz4Compress(void const *in, std::size_t inSize, BufferFactory &&bf)</div><div class="ttdoc">LZ4 block compression.</div><div class="ttdef"><b>Definition</b> <a href="CompressionAlgorithms_8h_source.html#l00046">CompressionAlgorithms.h:46</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression__algorithms_html_aaac3950d953bd5bf03fdca6e8de0cc85"><div class="ttname"><a href="namespaceripple_1_1compression__algorithms.html#aaac3950d953bd5bf03fdca6e8de0cc85">ripple::compression_algorithms::lz4Decompress</a></div><div class="ttdeci">std::size_t lz4Decompress(std::uint8_t const *in, std::size_t inSizeUnchecked, std::uint8_t *decompressed, std::size_t decompressedSizeUnchecked)</div><div class="ttdef"><b>Definition</b> <a href="CompressionAlgorithms_8h_source.html#l00076">CompressionAlgorithms.h:76</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a0677d67ee538c34d3b8effde7364de10"><div class="ttname"><a href="namespaceripple_1_1compression.html#a0677d67ee538c34d3b8effde7364de10">ripple::compression::headerBytes</a></div><div class="ttdeci">std::size_t constexpr headerBytes</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00030">Compression.h:30</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a566b52accba07f1d57a3b44d2522b146"><div class="ttname"><a href="namespaceripple_1_1compression.html#a566b52accba07f1d57a3b44d2522b146">ripple::compression::compress</a></div><div class="ttdeci">std::size_t compress(void const *in, std::size_t inSize, BufferFactory &&bf, Algorithm algorithm=Algorithm::LZ4)</div><div class="ttdoc">Compress input data.</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00088">Compression.h:88</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#l00037">Compression.h:37</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a63d59b12f7e712c378860771ef3fdf5fa521c36a31c2762741cf0f8890cbe05e3"><div class="ttname"><a href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5fa521c36a31c2762741cf0f8890cbe05e3">ripple::compression::Compressed::On</a></div><div class="ttdeci">@ On</div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a63d59b12f7e712c378860771ef3fdf5fad15305d7a4e34e02489c74a5ef542f36"><div class="ttname"><a href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5fad15305d7a4e34e02489c74a5ef542f36">ripple::compression::Compressed::Off</a></div><div class="ttdeci">@ Off</div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a65e2ec5e871a86d15892ae7d696a83c9"><div class="ttname"><a href="namespaceripple_1_1compression.html#a65e2ec5e871a86d15892ae7d696a83c9">ripple::compression::decompress</a></div><div class="ttdeci">std::size_t decompress(InputStream &in, std::size_t inSize, std::uint8_t *decompressed, std::size_t decompressedSize, Algorithm algorithm=Algorithm::LZ4)</div><div class="ttdoc">Decompress input stream.</div><div class="ttdef"><b>Definition:</b> <a href="Compression_8h_source.html#l00049">Compression.h:49</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a8fcbb9f961390f96a3cd32cef64bb640"><div class="ttname"><a href="namespaceripple_1_1compression.html#a8fcbb9f961390f96a3cd32cef64bb640">ripple::compression::headerBytesCompressed</a></div><div class="ttdeci">std::size_t constexpr headerBytesCompressed</div><div class="ttdef"><b>Definition:</b> <a href="Compression_8h_source.html#l00031">Compression.h:31</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#l00035">Compression.h:35</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a65e2ec5e871a86d15892ae7d696a83c9"><div class="ttname"><a href="namespaceripple_1_1compression.html#a65e2ec5e871a86d15892ae7d696a83c9">ripple::compression::decompress</a></div><div class="ttdeci">std::size_t decompress(InputStream &in, std::size_t inSize, std::uint8_t *decompressed, std::size_t decompressedSize, Algorithm algorithm=Algorithm::LZ4)</div><div class="ttdoc">Decompress input stream.</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00049">Compression.h:49</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_a8fcbb9f961390f96a3cd32cef64bb640"><div class="ttname"><a href="namespaceripple_1_1compression.html#a8fcbb9f961390f96a3cd32cef64bb640">ripple::compression::headerBytesCompressed</a></div><div class="ttdeci">std::size_t constexpr headerBytesCompressed</div><div class="ttdef"><b>Definition</b> <a href="Compression_8h_source.html#l00031">Compression.h:31</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#l00035">Compression.h:35</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_ac4e4ca1236f472d7e218c3f69cd8605ba6adf97f83acf6453d4a6a4b1070f3754"><div class="ttname"><a href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605ba6adf97f83acf6453d4a6a4b1070f3754">ripple::compression::Algorithm::None</a></div><div class="ttdeci">@ None</div></div>
|
||||
<div class="ttc" id="anamespaceripple_1_1compression_html_ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594"><div class="ttname"><a href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594">ripple::compression::Algorithm::LZ4</a></div><div class="ttdeci">@ LZ4</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#l00025">algorithm.h:25</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#l00025">algorithm.h:25</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_a94e13759bd026c8ac305482e17f05adb"><div class="ttname"><a href="namespaceripple.html#a94e13759bd026c8ac305482e17f05adb">ripple::debugLog</a></div><div class="ttdeci">beast::Journal debugLog()</div><div class="ttdoc">Returns a debug journal.</div><div class="ttdef"><b>Definition:</b> <a href="Log_8cpp_source.html#l00468">Log.cpp:468</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_html_a94e13759bd026c8ac305482e17f05adb"><div class="ttname"><a href="namespaceripple.html#a94e13759bd026c8ac305482e17f05adb">ripple::debugLog</a></div><div class="ttdeci">beast::Journal debugLog()</div><div class="ttdoc">Returns a debug journal.</div><div class="ttdef"><b>Definition</b> <a href="Log_8cpp_source.html#l00468">Log.cpp:468</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><!-- fragment --></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.5
|
||||
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>
|
||||
|
||||
Reference in New Issue
Block a user