ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b9058045945c27a01d3620507f47e55634c65d89
rippled/namespaceripple_1_1compression.html
manojsdoshi 76ee98eab2 deploy: de0c527387
2020-06-30 22:25:39 +00:00

352 lines
19 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">
<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: ripple::compression Namespace 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 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&amp;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&amp;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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1compression.html">compression</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">ripple::compression Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ac4e4ca1236f472d7e218c3f69cd8605b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a> : std::uint8_t { <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605ba6adf97f83acf6453d4a6a4b1070f3754">Algorithm::None</a> = 0x00,
<a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594">Algorithm::LZ4</a> = 0x90
}</td></tr>
<tr class="separator:ac4e4ca1236f472d7e218c3f69cd8605b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d59b12f7e712c378860771ef3fdf5f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">Compressed</a> : std::uint8_t { <a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5fa521c36a31c2762741cf0f8890cbe05e3">Compressed::On</a>,
<a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5fad15305d7a4e34e02489c74a5ef542f36">Compressed::Off</a>
}</td></tr>
<tr class="separator:a63d59b12f7e712c378860771ef3fdf5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a65e2ec5e871a86d15892ae7d696a83c9"><td class="memTemplParams" colspan="2">template&lt;typename InputStream &gt; </td></tr>
<tr class="memitem:a65e2ec5e871a86d15892ae7d696a83c9"><td class="memTemplItemLeft" 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="memTemplItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1compression.html#a65e2ec5e871a86d15892ae7d696a83c9">decompress</a> (InputStream &amp;in, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> inSize, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> *decompressed, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> decompressedSize, <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a> algorithm=<a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594">Algorithm::LZ4</a>)</td></tr>
<tr class="memdesc:a65e2ec5e871a86d15892ae7d696a83c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decompress input stream. <a href="namespaceripple_1_1compression.html#a65e2ec5e871a86d15892ae7d696a83c9">More...</a><br /></td></tr>
<tr class="separator:a65e2ec5e871a86d15892ae7d696a83c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a566b52accba07f1d57a3b44d2522b146"><td class="memTemplParams" colspan="2">template&lt;class BufferFactory &gt; </td></tr>
<tr class="memitem:a566b52accba07f1d57a3b44d2522b146"><td class="memTemplItemLeft" 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="memTemplItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1compression.html#a566b52accba07f1d57a3b44d2522b146">compress</a> (void const *in, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> inSize, BufferFactory &amp;&amp;bf, <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">Algorithm</a> algorithm=<a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594">Algorithm::LZ4</a>)</td></tr>
<tr class="memdesc:a566b52accba07f1d57a3b44d2522b146"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compress input data. <a href="namespaceripple_1_1compression.html#a566b52accba07f1d57a3b44d2522b146">More...</a><br /></td></tr>
<tr class="separator:a566b52accba07f1d57a3b44d2522b146"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a4e8d7a6815875e315924dcc7a066797a"><td class="memItemLeft" align="right" valign="top">constexpr <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="namespaceripple_1_1compression.html#a4e8d7a6815875e315924dcc7a066797a">headerBytes</a> = 6</td></tr>
<tr class="separator:a4e8d7a6815875e315924dcc7a066797a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a879a2a52c8f0b5818e800452b990443e"><td class="memItemLeft" align="right" valign="top">constexpr <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="namespaceripple_1_1compression.html#a879a2a52c8f0b5818e800452b990443e">headerBytesCompressed</a> = 10</td></tr>
<tr class="separator:a879a2a52c8f0b5818e800452b990443e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ac4e4ca1236f472d7e218c3f69cd8605b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4e4ca1236f472d7e218c3f69cd8605b">&#9670;&nbsp;</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">enum <a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605b">ripple::compression::Algorithm</a> : <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac4e4ca1236f472d7e218c3f69cd8605ba6adf97f83acf6453d4a6a4b1070f3754"></a>None&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594"></a>LZ4&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="Compression_8h_source.html#l00036">36</a> of file <a class="el" href="Compression_8h_source.html">Compression.h</a>.</p>
</div>
</div>
<a id="a63d59b12f7e712c378860771ef3fdf5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63d59b12f7e712c378860771ef3fdf5f">&#9670;&nbsp;</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">enum <a class="el" href="namespaceripple_1_1compression.html#a63d59b12f7e712c378860771ef3fdf5f">ripple::compression::Compressed</a> : <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a63d59b12f7e712c378860771ef3fdf5fa521c36a31c2762741cf0f8890cbe05e3"></a>On&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a63d59b12f7e712c378860771ef3fdf5fad15305d7a4e34e02489c74a5ef542f36"></a>Off&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="Compression_8h_source.html#l00038">38</a> of file <a class="el" href="Compression_8h_source.html">Compression.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a65e2ec5e871a86d15892ae7d696a83c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65e2ec5e871a86d15892ae7d696a83c9">&#9670;&nbsp;</a></span>decompress()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename InputStream &gt; </div>
<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::compression::decompress </td>
<td>(</td>
<td class="paramtype">InputStream &amp;&#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/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>inSize</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::uint8_t</a> *&#160;</td>
<td class="paramname"><em>decompressed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>decompressedSize</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>algorithm</em> = <code><a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594">Algorithm::LZ4</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decompress input stream. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">InputStream</td><td><a class="el" href="classripple_1_1ZeroCopyInputStream.html" title="Implements ZeroCopyInputStream around a buffer sequence.">ZeroCopyInputStream</a> </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>Input source stream </td></tr>
<tr><td class="paramname">inSize</td><td>Size of compressed data </td></tr>
<tr><td class="paramname">decompressed</td><td><a class="el" href="classripple_1_1Buffer.html" title="Like std::vector&lt;char&gt; but better.">Buffer</a> to hold decompressed message </td></tr>
<tr><td class="paramname">algorithm</td><td>Compression algorithm type </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Size of decompressed data or zero if failed to decompress </dd></dl>
<p class="definition">Definition at line <a class="el" href="Compression_8h_source.html#l00050">50</a> of file <a class="el" href="Compression_8h_source.html">Compression.h</a>.</p>
</div>
</div>
<a id="a566b52accba07f1d57a3b44d2522b146"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a566b52accba07f1d57a3b44d2522b146">&#9670;&nbsp;</a></span>compress()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class BufferFactory &gt; </div>
<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::compression::compress </td>
<td>(</td>
<td class="paramtype">void const *&#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/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>inSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BufferFactory &amp;&amp;&#160;</td>
<td class="paramname"><em>bf</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>algorithm</em> = <code><a class="el" href="namespaceripple_1_1compression.html#ac4e4ca1236f472d7e218c3f69cd8605baca0c64c0de8f56bc573828ea6d764594">Algorithm::LZ4</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compress input data. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">BufferFactory</td><td>Callable object or lambda. Takes the requested buffer size and returns allocated buffer pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>Data to compress </td></tr>
<tr><td class="paramname">inSize</td><td>Size of the data </td></tr>
<tr><td class="paramname">bf</td><td>Compressed buffer allocator </td></tr>
<tr><td class="paramname">algorithm</td><td>Compression algorithm type </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Size of compressed data, or zero if failed to compress </dd></dl>
<p class="definition">Definition at line <a class="el" href="Compression_8h_source.html#l00087">87</a> of file <a class="el" href="Compression_8h_source.html">Compression.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a4e8d7a6815875e315924dcc7a066797a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e8d7a6815875e315924dcc7a066797a">&#9670;&nbsp;</a></span>headerBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::compression::headerBytes = 6</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Compression_8h_source.html#l00031">31</a> of file <a class="el" href="Compression_8h_source.html">Compression.h</a>.</p>
</div>
</div>
<a id="a879a2a52c8f0b5818e800452b990443e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a879a2a52c8f0b5818e800452b990443e">&#9670;&nbsp;</a></span>headerBytesCompressed</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::compression::headerBytesCompressed = 10</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Compression_8h_source.html#l00032">32</a> of file <a class="el" href="Compression_8h_source.html">Compression.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink