ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-24 13:05:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/namespaceripple_1_1compression__algorithms.html
nbougalis 7bfed76f34 deploy: d49b486224
2022-01-13 21:46:19 +00:00

267 lines
14 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_algorithms 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__algorithms.html">compression_algorithms</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ripple::compression_algorithms Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8fb4610c8381afcf3d92ddfff9dbf0cf"><td class="memTemplParams" colspan="2">template&lt;typename BufferFactory &gt; </td></tr>
<tr class="memitem:a8fb4610c8381afcf3d92ddfff9dbf0cf"><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__algorithms.html#a8fb4610c8381afcf3d92ddfff9dbf0cf">lz4Compress</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)</td></tr>
<tr class="memdesc:a8fb4610c8381afcf3d92ddfff9dbf0cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">LZ4 block compression. <a href="namespaceripple_1_1compression__algorithms.html#a8fb4610c8381afcf3d92ddfff9dbf0cf">More...</a><br /></td></tr>
<tr class="separator:a8fb4610c8381afcf3d92ddfff9dbf0cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaac3950d953bd5bf03fdca6e8de0cc85"><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="namespaceripple_1_1compression__algorithms.html#aaac3950d953bd5bf03fdca6e8de0cc85">lz4Decompress</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> const *in, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> inSizeUnchecked, <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> decompressedSizeUnchecked)</td></tr>
<tr class="separator:aaac3950d953bd5bf03fdca6e8de0cc85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5001af4f7a6dad195e48601c3941785"><td class="memTemplParams" colspan="2">template&lt;typename InputStream &gt; </td></tr>
<tr class="memitem:aa5001af4f7a6dad195e48601c3941785"><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__algorithms.html#aa5001af4f7a6dad195e48601c3941785">lz4Decompress</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)</td></tr>
<tr class="memdesc:aa5001af4f7a6dad195e48601c3941785"><td class="mdescLeft">&#160;</td><td class="mdescRight">LZ4 block decompression. <a href="namespaceripple_1_1compression__algorithms.html#aa5001af4f7a6dad195e48601c3941785">More...</a><br /></td></tr>
<tr class="separator:aa5001af4f7a6dad195e48601c3941785"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a8fb4610c8381afcf3d92ddfff9dbf0cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fb4610c8381afcf3d92ddfff9dbf0cf">&#9670;&nbsp;</a></span>lz4Compress()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename 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_algorithms::lz4Compress </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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>LZ4 block compression. </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>
</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="CompressionAlgorithms_8h_source.html#l00044">44</a> of file <a class="el" href="CompressionAlgorithms_8h_source.html">CompressionAlgorithms.h</a>.</p>
</div>
</div>
<a id="aaac3950d953bd5bf03fdca6e8de0cc85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaac3950d953bd5bf03fdca6e8de0cc85">&#9670;&nbsp;</a></span>lz4Decompress() <span class="overload">[1/2]</span></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::compression_algorithms::lz4Decompress </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>
</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>inSizeUnchecked</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>decompressedSizeUnchecked</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>Compressed data </td></tr>
<tr><td class="paramname">inSizeUnchecked</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 data </td></tr>
<tr><td class="paramname">decompressedSizeUnchecked</td><td>Size of the decompressed buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the decompressed data </dd></dl>
<p class="definition">Definition at line <a class="el" href="CompressionAlgorithms_8h_source.html#l00074">74</a> of file <a class="el" href="CompressionAlgorithms_8h_source.html">CompressionAlgorithms.h</a>.</p>
</div>
</div>
<a id="aa5001af4f7a6dad195e48601c3941785"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5001af4f7a6dad195e48601c3941785">&#9670;&nbsp;</a></span>lz4Decompress() <span class="overload">[2/2]</span></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_algorithms::lz4Decompress </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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>LZ4 block decompression. </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 data </td></tr>
<tr><td class="paramname">decompressedSize</td><td>Size of the decompressed buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the decompressed data </dd></dl>
<p class="definition">Definition at line <a class="el" href="CompressionAlgorithms_8h_source.html#l00109">109</a> of file <a class="el" href="CompressionAlgorithms_8h_source.html">CompressionAlgorithms.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