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
e5d00ab2bf5a6fed840f2f17ebf7ba99974fe875
rippled/classripple_1_1json__body_1_1reader.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

309 lines
16 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::json_body::reader 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.5 -->
<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="structripple_1_1json__body.html">json_body</a></li><li class="navelem"><a class="el" href="classripple_1_1json__body_1_1reader.html">reader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1json__body_1_1reader-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::json_body::reader Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="json__body_8h_source.html">json_body.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aac715e7ab0663cf5f487f11ab29cd3f2"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1reader.html#aac715e7ab0663cf5f487f11ab29cd3f2">const_buffers_type</a> = typename dynamic_buffer_type::const_buffers_type</td></tr>
<tr class="separator:aac715e7ab0663cf5f487f11ab29cd3f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accabfe77b0b570cf85458526248d16ac"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1reader.html#accabfe77b0b570cf85458526248d16ac">is_deferred</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integral_constant.html">std::false_type</a></td></tr>
<tr class="separator:accabfe77b0b570cf85458526248d16ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a152a69c57a7782af9941e619ab1de008"><td class="memTemplParams" colspan="2">template&lt;bool isRequest, class Fields &gt; </td></tr>
<tr class="memitem:a152a69c57a7782af9941e619ab1de008"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1reader.html#a152a69c57a7782af9941e619ab1de008">reader</a> (boost::beast::http::message&lt; isRequest, <a class="el" href="structripple_1_1json__body.html">json_body</a>, Fields &gt; const &amp;m)</td></tr>
<tr class="separator:a152a69c57a7782af9941e619ab1de008"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0b49b74cd669273da1c7dceb38c6d0a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1reader.html#ae0b49b74cd669273da1c7dceb38c6d0a">init</a> (boost::beast::error_code &amp;) noexcept</td></tr>
<tr class="separator:ae0b49b74cd669273da1c7dceb38c6d0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a254b620e094590103c4edb5e9054dee8"><td class="memItemLeft" align="right" valign="top">boost::optional&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>&lt; <a class="el" href="classripple_1_1json__body_1_1reader.html#aac715e7ab0663cf5f487f11ab29cd3f2">const_buffers_type</a>, bool &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1reader.html#a254b620e094590103c4edb5e9054dee8">get</a> (boost::beast::error_code &amp;ec)</td></tr>
<tr class="separator:a254b620e094590103c4edb5e9054dee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b61715da933aa19cb1b889cccd27fdb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1reader.html#a6b61715da933aa19cb1b889cccd27fdb">finish</a> (boost::beast::error_code &amp;)</td></tr>
<tr class="separator:a6b61715da933aa19cb1b889cccd27fdb"><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:a85c7d2b033f2b755ab671317f6a3145d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1reader.html#a85c7d2b033f2b755ab671317f6a3145d">dynamic_buffer_type</a> = boost::beast::multi_buffer</td></tr>
<tr class="separator:a85c7d2b033f2b755ab671317f6a3145d"><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:a20ff9a9f234fca1f7e25d39c112e4dab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1json__body_1_1reader.html#a85c7d2b033f2b755ab671317f6a3145d">dynamic_buffer_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1reader.html#a20ff9a9f234fca1f7e25d39c112e4dab">buffer_</a></td></tr>
<tr class="separator:a20ff9a9f234fca1f7e25d39c112e4dab"><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="json__body_8h_source.html#l00038">38</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a85c7d2b033f2b755ab671317f6a3145d" name="a85c7d2b033f2b755ab671317f6a3145d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85c7d2b033f2b755ab671317f6a3145d">&#9670;&#160;</a></span>dynamic_buffer_type</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="classripple_1_1json__body_1_1reader.html#a85c7d2b033f2b755ab671317f6a3145d">ripple::json_body::reader::dynamic_buffer_type</a> = boost::beast::multi_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="json__body_8h_source.html#l00040">40</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div>
</div>
<a id="aac715e7ab0663cf5f487f11ab29cd3f2" name="aac715e7ab0663cf5f487f11ab29cd3f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac715e7ab0663cf5f487f11ab29cd3f2">&#9670;&#160;</a></span>const_buffers_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1json__body_1_1reader.html#aac715e7ab0663cf5f487f11ab29cd3f2">ripple::json_body::reader::const_buffers_type</a> = typename dynamic_buffer_type::const_buffers_type</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="json__body_8h_source.html#l00045">45</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div>
</div>
<a id="accabfe77b0b570cf85458526248d16ac" name="accabfe77b0b570cf85458526248d16ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accabfe77b0b570cf85458526248d16ac">&#9670;&#160;</a></span>is_deferred</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1json__body_1_1reader.html#accabfe77b0b570cf85458526248d16ac">ripple::json_body::reader::is_deferred</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integral_constant.html">std::false_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="json__body_8h_source.html#l00048">48</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a152a69c57a7782af9941e619ab1de008" name="a152a69c57a7782af9941e619ab1de008"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a152a69c57a7782af9941e619ab1de008">&#9670;&#160;</a></span>reader()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;bool isRequest, class Fields &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::json_body::reader::reader </td>
<td>(</td>
<td class="paramtype">boost::beast::http::message&lt; isRequest, <a class="el" href="structripple_1_1json__body.html">json_body</a>, Fields &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="json__body_8h_source.html#l00051">51</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae0b49b74cd669273da1c7dceb38c6d0a" name="ae0b49b74cd669273da1c7dceb38c6d0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0b49b74cd669273da1c7dceb38c6d0a">&#9670;&#160;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::json_body::reader::init </td>
<td>(</td>
<td class="paramtype">boost::beast::error_code &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="json__body_8h_source.html#l00061">61</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div>
</div>
<a id="a254b620e094590103c4edb5e9054dee8" name="a254b620e094590103c4edb5e9054dee8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a254b620e094590103c4edb5e9054dee8">&#9670;&#160;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::optional&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>&lt; <a class="el" href="classripple_1_1json__body_1_1reader.html#aac715e7ab0663cf5f487f11ab29cd3f2">const_buffers_type</a>, bool &gt; &gt; ripple::json_body::reader::get </td>
<td>(</td>
<td class="paramtype">boost::beast::error_code &amp;&#160;</td>
<td class="paramname"><em>ec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="json__body_8h_source.html#l00068">68</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div>
</div>
<a id="a6b61715da933aa19cb1b889cccd27fdb" name="a6b61715da933aa19cb1b889cccd27fdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b61715da933aa19cb1b889cccd27fdb">&#9670;&#160;</a></span>finish()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::json_body::reader::finish </td>
<td>(</td>
<td class="paramtype">boost::beast::error_code &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="json__body_8h_source.html#l00074">74</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a20ff9a9f234fca1f7e25d39c112e4dab" name="a20ff9a9f234fca1f7e25d39c112e4dab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20ff9a9f234fca1f7e25d39c112e4dab">&#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="el" href="classripple_1_1json__body_1_1reader.html#a85c7d2b033f2b755ab671317f6a3145d">dynamic_buffer_type</a> ripple::json_body::reader::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="json__body_8h_source.html#l00042">42</a> of file <a class="el" href="json__body_8h_source.html">json_body.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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink