ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 11:35:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
39032171d185a8703b53d77cc7253e3960e8cddc
rippled/TxFormats_8h_source.html
bthomee 39032171d1 deploy: 6534757d85
2025-07-10 18:20:07 +00:00

160 lines
18 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: TxFormats.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.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="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_8d04e3c0b58cad28d7755ed462d1b6c0.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">TxFormats.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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></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="preprocessor">#ifndef RIPPLE_PROTOCOL_TXFORMATS_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_PROTOCOL_TXFORMATS_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpl/protocol/KnownFormats.h&gt;</span></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><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">// clang-format off</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126"> 56</a></span><span class="keyword">enum</span> <a class="code hl_enumeration" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126">TxType</a> : <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a></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> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#pragma push_macro(&quot;TRANSACTION&quot;</span>)</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#undef TRANSACTION</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="preprocessor">#define TRANSACTION(tag, value, name, delegatable, fields) tag = value,</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#include &lt;xrpl/protocol/detail/transactions.macro&gt;</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#undef TRANSACTION</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="preprocessor">#pragma pop_macro(&quot;TRANSACTION&quot;</span>)</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126af4c29dae760cef4d733dea12d1a9ffef"> 70</a></span> <a class="code hl_enumvalue" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126af4c29dae760cef4d733dea12d1a9ffef">ttNICKNAME_SET</a> [[deprecated(<span class="stringliteral">&quot;This transaction type is not supported and should not be used.&quot;</span>)]] = 6,</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a468081cbd064df5054b467c19a7e47de"> 73</a></span> <a class="code hl_enumvalue" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a468081cbd064df5054b467c19a7e47de">ttCONTRACT</a> [[deprecated(<span class="stringliteral">&quot;This transaction type is not supported and should not be used.&quot;</span>)]] = 9,</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a12d03eb7a5152bb5025537e3b5a2042b"> 76</a></span> <a class="code hl_enumvalue" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a12d03eb7a5152bb5025537e3b5a2042b">ttSPINAL_TAP</a> [[deprecated(<span class="stringliteral">&quot;This transaction type is not supported and should not be used.&quot;</span>)]] = 11,</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a9fb6acbfd4c3a91f61bf218ef9a8005a"> 79</a></span> <a class="code hl_enumvalue" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a9fb6acbfd4c3a91f61bf218ef9a8005a">ttHOOK_SET</a> [[maybe_unused]] = 22,</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>};</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">// clang-format on</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classripple_1_1TxFormats.html"> 85</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1TxFormats.html">TxFormats</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1KnownFormats.html">KnownFormats</a>&lt;TxType, TxFormats&gt;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>{</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <a class="code hl_function" href="classripple_1_1TxFormats.html#a54e184544beb0cd141f171aa7040e0d7">TxFormats</a>();</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TxFormats.html">TxFormats</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_function" href="classripple_1_1TxFormats.html#a1db8e0fb64564b47c2c33ff763ccc8c3">getInstance</a>();</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>};</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html"><div class="ttname"><a href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a></div><div class="ttdoc">Manages a list of known formats.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00042">KnownFormats.h:43</a></div></div>
<div class="ttc" id="aclassripple_1_1TxFormats_html"><div class="ttname"><a href="classripple_1_1TxFormats.html">ripple::TxFormats</a></div><div class="ttdoc">Manages the list of known transaction formats.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8h_source.html#l00085">TxFormats.h:86</a></div></div>
<div class="ttc" id="aclassripple_1_1TxFormats_html_a1db8e0fb64564b47c2c33ff763ccc8c3"><div class="ttname"><a href="classripple_1_1TxFormats.html#a1db8e0fb64564b47c2c33ff763ccc8c3">ripple::TxFormats::getInstance</a></div><div class="ttdeci">static TxFormats const &amp; getInstance()</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8cpp_source.html#l00070">TxFormats.cpp:70</a></div></div>
<div class="ttc" id="aclassripple_1_1TxFormats_html_a54e184544beb0cd141f171aa7040e0d7"><div class="ttname"><a href="classripple_1_1TxFormats.html#a54e184544beb0cd141f171aa7040e0d7">ripple::TxFormats::TxFormats</a></div><div class="ttdeci">TxFormats()</div><div class="ttdoc">Create the object.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8cpp_source.html#l00029">TxFormats.cpp:29</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</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#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2ce3074a39ea65126b82fc59baf43126"><div class="ttname"><a href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126">ripple::TxType</a></div><div class="ttdeci">TxType</div><div class="ttdoc">Transaction type identifiers.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8h_source.html#l00056">TxFormats.h:57</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2ce3074a39ea65126b82fc59baf43126a12d03eb7a5152bb5025537e3b5a2042b"><div class="ttname"><a href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a12d03eb7a5152bb5025537e3b5a2042b">ripple::ttSPINAL_TAP</a></div><div class="ttdeci">@ ttSPINAL_TAP</div><div class="ttdoc">This identifier was never used, but the slot is reserved for historical purposes.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8h_source.html#l00076">TxFormats.h:76</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2ce3074a39ea65126b82fc59baf43126a468081cbd064df5054b467c19a7e47de"><div class="ttname"><a href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a468081cbd064df5054b467c19a7e47de">ripple::ttCONTRACT</a></div><div class="ttdeci">@ ttCONTRACT</div><div class="ttdoc">This transaction type is deprecated; it is retained for historical purposes.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8h_source.html#l00073">TxFormats.h:73</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2ce3074a39ea65126b82fc59baf43126a9fb6acbfd4c3a91f61bf218ef9a8005a"><div class="ttname"><a href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126a9fb6acbfd4c3a91f61bf218ef9a8005a">ripple::ttHOOK_SET</a></div><div class="ttdeci">@ ttHOOK_SET</div><div class="ttdoc">This transaction type installs a hook.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8h_source.html#l00079">TxFormats.h:79</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2ce3074a39ea65126b82fc59baf43126af4c29dae760cef4d733dea12d1a9ffef"><div class="ttname"><a href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126af4c29dae760cef4d733dea12d1a9ffef">ripple::ttNICKNAME_SET</a></div><div class="ttdeci">@ ttNICKNAME_SET</div><div class="ttdoc">This transaction type is deprecated; it is retained for historical purposes.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8h_source.html#l00070">TxFormats.h:70</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink