ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/SimpleWriter_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

178 lines
19 KiB
HTML
Raw Permalink 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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: SimpleWriter.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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()"
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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_9d7e4921ea2f62e76f4d31f5afd6d533.html">server</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">SimpleWriter.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_SERVER_SIMPLEWRITER_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_SERVER_SIMPLEWRITER_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/server/Writer.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;boost/beast/core/multi_buffer.hpp&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;boost/beast/core/ostream.hpp&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;boost/beast/http/message.hpp&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;boost/beast/http/write.hpp&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a>&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classripple_1_1SimpleWriter.html"> 16</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1SimpleWriter.html">SimpleWriter</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1Writer.html">Writer</a></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>{</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classripple_1_1SimpleWriter.html#ad36f903844689be92f92253dcea08955"> 18</a></span> boost::beast::multi_buffer <a class="code hl_variable" href="classripple_1_1SimpleWriter.html#ad36f903844689be92f92253dcea08955">sb_</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">template</span> &lt;<span class="keywordtype">bool</span> isRequest, <span class="keyword">class</span> Body, <span class="keyword">class</span> Fields&gt;</div>
<div class="foldopen" id="foldopen00022" data-start="{" data-end="}">
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classripple_1_1SimpleWriter.html#a8370606c186d94c383701d44a5e3f777"> 22</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1SimpleWriter.html#a8370606c186d94c383701d44a5e3f777">SimpleWriter</a>(</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> boost::beast::http::message&lt;isRequest, Body, Fields&gt; <span class="keyword">const</span>&amp; msg)</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> boost::beast::ostream(<a class="code hl_variable" href="classripple_1_1SimpleWriter.html#ad36f903844689be92f92253dcea08955">sb_</a>) &lt;&lt; msg;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> }</div>
</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="}">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classripple_1_1SimpleWriter.html#aed8940f922abaa05f76a4bdfcf4e9669"> 29</a></span> <a class="code hl_function" href="classripple_1_1SimpleWriter.html#aed8940f922abaa05f76a4bdfcf4e9669">complete</a>()<span class="keyword"> override</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1SimpleWriter.html#ad36f903844689be92f92253dcea08955">sb_</a>.size() == 0;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> }</div>
</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="}">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classripple_1_1SimpleWriter.html#aa60007a776c86d8f6d667b61b2c32c9d"> 35</a></span> <a class="code hl_function" href="classripple_1_1SimpleWriter.html#aa60007a776c86d8f6d667b61b2c32c9d">consume</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> bytes)<span class="keyword"> override</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_variable" href="classripple_1_1SimpleWriter.html#ad36f903844689be92f92253dcea08955">sb_</a>.consume(bytes);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00041" data-start="{" data-end="}">
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classripple_1_1SimpleWriter.html#aab58cb9243a4f45472fb467ce2ef0d6d"> 41</a></span> <a class="code hl_function" href="classripple_1_1SimpleWriter.html#aab58cb9243a4f45472fb467ce2ef0d6d">prepare</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> bytes, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;<span class="keywordtype">void</span>(<span class="keywordtype">void</span>)&gt;)<span class="keyword"> override</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;boost::asio::const_buffer&gt;</a></div>
<div class="foldopen" id="foldopen00047" data-start="{" data-end="}">
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classripple_1_1SimpleWriter.html#a21f6c11438273c7b821bb358b212f84c"> 47</a></span> <a class="code hl_function" href="classripple_1_1SimpleWriter.html#a21f6c11438273c7b821bb358b212f84c">data</a>()<span class="keyword"> override</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">auto</span> <span class="keyword">const</span>&amp; buf = <a class="code hl_variable" href="classripple_1_1SimpleWriter.html#ad36f903844689be92f92253dcea08955">sb_</a>.data();</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;boost::asio::const_buffer&gt;</a> result;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> result.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/container/vector/reserve.html">reserve</a>(<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/iterator/distance.html">std::distance</a>(buf.begin(), buf.end()));</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span> <span class="keyword">const</span> b : buf)</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> result.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">push_back</a>(b);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">return</span> result;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> }</div>
</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>};</div>
</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1SimpleWriter_html"><div class="ttname"><a href="classripple_1_1SimpleWriter.html">ripple::SimpleWriter</a></div><div class="ttdoc">Deprecated: Writer that serializes a HTTP/1 message.</div><div class="ttdef"><b>Definition</b> <a href="SimpleWriter_8h_source.html#l00016">SimpleWriter.h:17</a></div></div>
<div class="ttc" id="aclassripple_1_1SimpleWriter_html_a21f6c11438273c7b821bb358b212f84c"><div class="ttname"><a href="classripple_1_1SimpleWriter.html#a21f6c11438273c7b821bb358b212f84c">ripple::SimpleWriter::data</a></div><div class="ttdeci">std::vector&lt; boost::asio::const_buffer &gt; data() override</div><div class="ttdoc">Returns a ConstBufferSequence representing the input sequence.</div><div class="ttdef"><b>Definition</b> <a href="SimpleWriter_8h_source.html#l00047">SimpleWriter.h:47</a></div></div>
<div class="ttc" id="aclassripple_1_1SimpleWriter_html_a8370606c186d94c383701d44a5e3f777"><div class="ttname"><a href="classripple_1_1SimpleWriter.html#a8370606c186d94c383701d44a5e3f777">ripple::SimpleWriter::SimpleWriter</a></div><div class="ttdeci">SimpleWriter(boost::beast::http::message&lt; isRequest, Body, Fields &gt; const &amp;msg)</div><div class="ttdef"><b>Definition</b> <a href="SimpleWriter_8h_source.html#l00022">SimpleWriter.h:22</a></div></div>
<div class="ttc" id="aclassripple_1_1SimpleWriter_html_aa60007a776c86d8f6d667b61b2c32c9d"><div class="ttname"><a href="classripple_1_1SimpleWriter.html#aa60007a776c86d8f6d667b61b2c32c9d">ripple::SimpleWriter::consume</a></div><div class="ttdeci">void consume(std::size_t bytes) override</div><div class="ttdoc">Removes bytes from the input sequence.</div><div class="ttdef"><b>Definition</b> <a href="SimpleWriter_8h_source.html#l00035">SimpleWriter.h:35</a></div></div>
<div class="ttc" id="aclassripple_1_1SimpleWriter_html_aab58cb9243a4f45472fb467ce2ef0d6d"><div class="ttname"><a href="classripple_1_1SimpleWriter.html#aab58cb9243a4f45472fb467ce2ef0d6d">ripple::SimpleWriter::prepare</a></div><div class="ttdeci">bool prepare(std::size_t bytes, std::function&lt; void(void)&gt;) override</div><div class="ttdoc">Add data to the input sequence.</div><div class="ttdef"><b>Definition</b> <a href="SimpleWriter_8h_source.html#l00041">SimpleWriter.h:41</a></div></div>
<div class="ttc" id="aclassripple_1_1SimpleWriter_html_ad36f903844689be92f92253dcea08955"><div class="ttname"><a href="classripple_1_1SimpleWriter.html#ad36f903844689be92f92253dcea08955">ripple::SimpleWriter::sb_</a></div><div class="ttdeci">boost::beast::multi_buffer sb_</div><div class="ttdef"><b>Definition</b> <a href="SimpleWriter_8h_source.html#l00018">SimpleWriter.h:18</a></div></div>
<div class="ttc" id="aclassripple_1_1SimpleWriter_html_aed8940f922abaa05f76a4bdfcf4e9669"><div class="ttname"><a href="classripple_1_1SimpleWriter.html#aed8940f922abaa05f76a4bdfcf4e9669">ripple::SimpleWriter::complete</a></div><div class="ttdeci">bool complete() override</div><div class="ttdoc">Returns true if there is no more data to pull.</div><div class="ttdef"><b>Definition</b> <a href="SimpleWriter_8h_source.html#l00029">SimpleWriter.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1Writer_html"><div class="ttname"><a href="classripple_1_1Writer.html">ripple::Writer</a></div><div class="ttdef"><b>Definition</b> <a href="server_2Writer_8h_source.html#l00011">server/Writer.h:12</a></div></div>
<div class="ttc" id="adistance_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/iterator/distance.html">std::distance</a></div><div class="ttdeci">T distance(T... args)</div></div>
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</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#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="apush_back_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">std::vector::push_back</a></div><div class="ttdeci">T push_back(T... args)</div></div>
<div class="ttc" id="areserve_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/reserve.html">std::vector::reserve</a></div><div class="ttdeci">T reserve(T... args)</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 class="ttc" id="autility_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></div></div>
</div><!-- fragment --></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>
Reference in New Issue View Git Blame Copy Permalink