Files
rippled/InnerObjectFormats_8cpp_source.html
2020-09-22 22:46:01 +00:00

166 lines
19 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">
<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: InnerObjectFormats.cpp 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 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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_1e765e6a8d5970800a535eb2615ec474.html">protocol</a></li><li class="navelem"><a class="el" href="dir_41c387a0f328eeb295307369675c1162.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">InnerObjectFormats.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/InnerObjectFormats.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classripple_1_1InnerObjectFormats.html#a266521cb88032dda52a171334123a7b1"> 24</a></span>&#160;<a class="code" href="classripple_1_1InnerObjectFormats.html#a266521cb88032dda52a171334123a7b1">InnerObjectFormats::InnerObjectFormats</a>()</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;{</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a6a4136f7e69948157f5e2bdf5aa6cb60">add</a>(<a class="code" href="namespaceripple.html#a13e8abe729e1e5b0f3cf6e0b20fb43ce">sfSignerEntry</a>.<a class="code" href="classripple_1_1SField.html#a45acf918dce2b1e3e40c6344a49f7b51">jsonName</a>.<a class="code" href="classJson_1_1StaticString.html#a21b996fc279e0aea6c063a565ed0308e">c_str</a>(),</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="namespaceripple.html#a13e8abe729e1e5b0f3cf6e0b20fb43ce">sfSignerEntry</a>.<a class="code" href="classripple_1_1SField.html#a0d7b091a27f18d0d4bdb734ccfd780a7">getCode</a>(),</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {sfAccount, soeREQUIRED},</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {sfSignerWeight, soeREQUIRED},</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; });</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; add(<a class="code" href="namespaceripple.html#a84208a9a90d0dc2143d3d49d1f053fbd">sfSigner</a>.<a class="code" href="classripple_1_1SField.html#a45acf918dce2b1e3e40c6344a49f7b51">jsonName</a>.<a class="code" href="classJson_1_1StaticString.html#a21b996fc279e0aea6c063a565ed0308e">c_str</a>(),</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="namespaceripple.html#a84208a9a90d0dc2143d3d49d1f053fbd">sfSigner</a>.<a class="code" href="classripple_1_1SField.html#a0d7b091a27f18d0d4bdb734ccfd780a7">getCode</a>(),</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {sfAccount, soeREQUIRED},</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {sfSigningPubKey, soeREQUIRED},</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {sfTxnSignature, soeREQUIRED},</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; });</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; add(sfMajority.<a class="code" href="classripple_1_1SField.html#a45acf918dce2b1e3e40c6344a49f7b51">jsonName</a>.<a class="code" href="classJson_1_1StaticString.html#a21b996fc279e0aea6c063a565ed0308e">c_str</a>(),</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; sfMajority.<a class="code" href="classripple_1_1SField.html#a0d7b091a27f18d0d4bdb734ccfd780a7">getCode</a>(),</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; {sfAmendment, soeREQUIRED},</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; {sfCloseTime, soeREQUIRED},</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; });</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; add(<a class="code" href="namespaceripple.html#a5704c95dc49172864465459cd250c353">sfDisabledValidator</a>.<a class="code" href="classripple_1_1SField.html#a45acf918dce2b1e3e40c6344a49f7b51">jsonName</a>.<a class="code" href="classJson_1_1StaticString.html#a21b996fc279e0aea6c063a565ed0308e">c_str</a>(),</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="namespaceripple.html#a5704c95dc49172864465459cd250c353">sfDisabledValidator</a>.<a class="code" href="classripple_1_1SField.html#a0d7b091a27f18d0d4bdb734ccfd780a7">getCode</a>(),</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; {sfPublicKey, soeREQUIRED},</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; {sfFirstLedgerSequence, soeREQUIRED},</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; });</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;}</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;InnerObjectFormats <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1InnerObjectFormats.html#ac8a2a46e333d5db2ecaff032e3eacc2f"> 57</a></span>&#160;InnerObjectFormats::getInstance()</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;{</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">static</span> <a class="code" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> instance;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> instance;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<a class="code" href="classripple_1_1SOTemplate.html">SOTemplate</a> <span class="keyword">const</span>*</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classripple_1_1InnerObjectFormats.html#a5d946acc2637ba9031007888980c3764"> 64</a></span>&#160;InnerObjectFormats::findSOTemplateBySField(<a class="code" href="classripple_1_1SField.html">SField</a> <span class="keyword">const</span>&amp; sField)<span class="keyword"> const</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">auto</span> itemPtr = findByType(sField.<a class="code" href="classripple_1_1SField.html#a0d7b091a27f18d0d4bdb734ccfd780a7">getCode</a>());</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">if</span> (itemPtr)</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">return</span> &amp;(itemPtr-&gt;getSOTemplate());</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;}</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;} <span class="comment">// namespace ripple</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1KnownFormats_html_a6a4136f7e69948157f5e2bdf5aa6cb60"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a6a4136f7e69948157f5e2bdf5aa6cb60">ripple::KnownFormats&lt; int &gt;::add</a></div><div class="ttdeci">Item const &amp; add(char const *name, int type, std::initializer_list&lt; SOElement &gt; uniqueFields, std::initializer_list&lt; SOElement &gt; commonFields={})</div><div class="ttdoc">Add a new format.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00168">KnownFormats.h:168</a></div></div>
<div class="ttc" id="aclassripple_1_1InnerObjectFormats_html_a266521cb88032dda52a171334123a7b1"><div class="ttname"><a href="classripple_1_1InnerObjectFormats.html#a266521cb88032dda52a171334123a7b1">ripple::InnerObjectFormats::InnerObjectFormats</a></div><div class="ttdeci">InnerObjectFormats()</div><div class="ttdoc">Create the object.</div><div class="ttdef"><b>Definition:</b> <a href="InnerObjectFormats_8cpp_source.html#l00024">InnerObjectFormats.cpp:24</a></div></div>
<div class="ttc" id="anamespaceripple_html_a84208a9a90d0dc2143d3d49d1f053fbd"><div class="ttname"><a href="namespaceripple.html#a84208a9a90d0dc2143d3d49d1f053fbd">ripple::sfSigner</a></div><div class="ttdeci">const SField sfSigner(access, STI_OBJECT, 16, &quot;Signer&quot;)</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00510">SField.h:510</a></div></div>
<div class="ttc" id="aclassJson_1_1StaticString_html_a21b996fc279e0aea6c063a565ed0308e"><div class="ttname"><a href="classJson_1_1StaticString.html#a21b996fc279e0aea6c063a565ed0308e">Json::StaticString::c_str</a></div><div class="ttdeci">constexpr const char * c_str() const</div><div class="ttdef"><b>Definition:</b> <a href="json__value_8h_source.html#l00073">json_value.h:73</a></div></div>
<div class="ttc" id="aclassripple_1_1SField_html_a45acf918dce2b1e3e40c6344a49f7b51"><div class="ttname"><a href="classripple_1_1SField.html#a45acf918dce2b1e3e40c6344a49f7b51">ripple::SField::jsonName</a></div><div class="ttdeci">const Json::StaticString jsonName</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00133">SField.h:133</a></div></div>
<div class="ttc" id="aclassripple_1_1SOTemplate_html"><div class="ttname"><a href="classripple_1_1SOTemplate.html">ripple::SOTemplate</a></div><div class="ttdoc">Defines the fields and their attributes within a STObject.</div><div class="ttdef"><b>Definition:</b> <a href="SOTemplate_8h_source.html#l00081">SOTemplate.h:81</a></div></div>
<div class="ttc" id="anamespaceripple_html_a13e8abe729e1e5b0f3cf6e0b20fb43ce"><div class="ttname"><a href="namespaceripple.html#a13e8abe729e1e5b0f3cf6e0b20fb43ce">ripple::sfSignerEntry</a></div><div class="ttdeci">const SField sfSignerEntry(access, STI_OBJECT, 11, &quot;SignerEntry&quot;)</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00509">SField.h:509</a></div></div>
<div class="ttc" id="aclassripple_1_1InnerObjectFormats_html"><div class="ttname"><a href="classripple_1_1InnerObjectFormats.html">ripple::InnerObjectFormats</a></div><div class="ttdoc">Manages the list of known inner object formats.</div><div class="ttdef"><b>Definition:</b> <a href="InnerObjectFormats_8h_source.html#l00029">InnerObjectFormats.h:29</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1SField_html"><div class="ttname"><a href="classripple_1_1SField.html">ripple::SField</a></div><div class="ttdoc">Identifies fields.</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00109">SField.h:109</a></div></div>
<div class="ttc" id="aclassripple_1_1SField_html_a0d7b091a27f18d0d4bdb734ccfd780a7"><div class="ttname"><a href="classripple_1_1SField.html#a0d7b091a27f18d0d4bdb734ccfd780a7">ripple::SField::getCode</a></div><div class="ttdeci">int getCode() const</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00226">SField.h:226</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5704c95dc49172864465459cd250c353"><div class="ttname"><a href="namespaceripple.html#a5704c95dc49172864465459cd250c353">ripple::sfDisabledValidator</a></div><div class="ttdeci">const SField sfDisabledValidator(access, STI_OBJECT, 19, &quot;DisabledValidator&quot;)</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00512">SField.h:512</a></div></div>
<!-- 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>