Files
rippled/classripple_1_1json__body_1_1writer.html
2025-08-19 09:49:50 -07:00

253 lines
13 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::json_body::writer 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.8 -->
<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_1writer.html">writer</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-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1json__body_1_1writer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::json_body::writer 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>
<div class="dynheader">
Collaboration diagram for ripple::json_body::writer:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1json__body_1_1writer__coll__graph.png" border="0" usemap="#aripple_1_1json__body_1_1writer_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1json__body_1_1writer_coll__map" id="aripple_1_1json__body_1_1writer_coll__map">
<area shape="rect" title=" " alt="" coords="5,183,145,223"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="32,95,119,120"/>
<area shape="poly" title=" " alt="" coords="78,134,78,182,73,182,73,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="6,5,145,45"/>
<area shape="poly" title=" " alt="" coords="78,59,78,94,73,94,73,59"/>
</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-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad52083d9507caa7eef780fbe56808961" id="r_ad52083d9507caa7eef780fbe56808961"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1writer.html#ad52083d9507caa7eef780fbe56808961">const_buffers_type</a> = boost::asio::const_buffer</td></tr>
<tr class="separator:ad52083d9507caa7eef780fbe56808961"><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:a0e4a5ae98b06e9478d1200f0482d3c31" id="r_a0e4a5ae98b06e9478d1200f0482d3c31"><td class="memTemplParams" colspan="2">template&lt;bool isRequest, class Fields &gt; </td></tr>
<tr class="memitem:a0e4a5ae98b06e9478d1200f0482d3c31"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1writer.html#a0e4a5ae98b06e9478d1200f0482d3c31">writer</a> (boost::beast::http::header&lt; isRequest, Fields &gt; const &amp;fields, <a class="el" href="structripple_1_1json__body.html#ac91f7440bc6afa91c7b33a98ee4fe183">value_type</a> const &amp;value)</td></tr>
<tr class="separator:a0e4a5ae98b06e9478d1200f0482d3c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0da41e821305c2f8a90d92659f384ce8" id="r_a0da41e821305c2f8a90d92659f384ce8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1writer.html#a0da41e821305c2f8a90d92659f384ce8">init</a> (boost::beast::error_code &amp;ec)</td></tr>
<tr class="separator:a0da41e821305c2f8a90d92659f384ce8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a558d5d6b1e5850fb74373a31ad2119" id="r_a3a558d5d6b1e5850fb74373a31ad2119"><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_1writer.html#ad52083d9507caa7eef780fbe56808961">const_buffers_type</a>, bool &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1writer.html#a3a558d5d6b1e5850fb74373a31ad2119">get</a> (boost::beast::error_code &amp;ec)</td></tr>
<tr class="separator:a3a558d5d6b1e5850fb74373a31ad2119"><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:a6745b373ddd685b941c4f8ac21ac368a" id="r_a6745b373ddd685b941c4f8ac21ac368a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1json__body_1_1writer.html#a6745b373ddd685b941c4f8ac21ac368a">body_string_</a></td></tr>
<tr class="separator:a6745b373ddd685b941c4f8ac21ac368a"><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#l00079">79</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="ad52083d9507caa7eef780fbe56808961" name="ad52083d9507caa7eef780fbe56808961"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad52083d9507caa7eef780fbe56808961">&#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_1writer.html#ad52083d9507caa7eef780fbe56808961">ripple::json_body::writer::const_buffers_type</a> = boost::asio::const_buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="json__body_8h_source.html#l00084">84</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="a0e4a5ae98b06e9478d1200f0482d3c31" name="a0e4a5ae98b06e9478d1200f0482d3c31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e4a5ae98b06e9478d1200f0482d3c31">&#9670;&#160;</a></span>writer()</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::writer::writer </td>
<td>(</td>
<td class="paramtype">boost::beast::http::header&lt; isRequest, Fields &gt; const &amp;&#160;</td>
<td class="paramname"><em>fields</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1json__body.html#ac91f7440bc6afa91c7b33a98ee4fe183">value_type</a> const &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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#l00087">87</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="a0da41e821305c2f8a90d92659f384ce8" name="a0da41e821305c2f8a90d92659f384ce8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0da41e821305c2f8a90d92659f384ce8">&#9670;&#160;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::json_body::writer::init </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#l00095">95</a> of file <a class="el" href="json__body_8h_source.html">json_body.h</a>.</p>
</div>
</div>
<a id="a3a558d5d6b1e5850fb74373a31ad2119" name="a3a558d5d6b1e5850fb74373a31ad2119"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a558d5d6b1e5850fb74373a31ad2119">&#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_1writer.html#ad52083d9507caa7eef780fbe56808961">const_buffers_type</a>, bool &gt; &gt; ripple::json_body::writer::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#l00103">103</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="a6745b373ddd685b941c4f8ac21ac368a" name="a6745b373ddd685b941c4f8ac21ac368a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6745b373ddd685b941c4f8ac21ac368a">&#9670;&#160;</a></span>body_string_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::json_body::writer::body_string_</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#l00081">81</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.8
</small></address>
</body>
</html>