mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-24 04:55:52 +00:00
184 lines
20 KiB
HTML
184 lines
20 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: CTID.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 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&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&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_f4afb74df24474efa0cc7e8ea3ddd5ce.html">rpc</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">CTID.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a 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 name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2019 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a 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 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 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 name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a 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 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 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 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 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 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 name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_RPC_CTID_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_RPC_CTID_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <boost/algorithm/string/predicate.hpp></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <boost/regex.hpp></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a>></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/regex.html">regex</a>></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/sstream.html">sstream</a>></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>RPC {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">inline</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<std::string></a></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a1832b06f613fc4f81a5183c79656e047"> 34</a></span> <a class="code" href="namespaceripple_1_1RPC.html#a1832b06f613fc4f81a5183c79656e047">encodeCTID</a>(</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  uint32_t ledger_seq,</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  uint16_t txn_index,</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  uint16_t network_id) noexcept</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">if</span> (ledger_seq > 0x0FFF<span class="stringliteral">'FFFF)</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="stringliteral"> return {};</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="stringliteral"></span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="stringliteral"> uint64_t ctidValue =</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="stringliteral"> ((0xC000'</span>0000ULL + <span class="keyword">static_cast<</span>uint64_t<span class="keyword">></span>(ledger_seq)) << 32) +</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  (<span class="keyword">static_cast<</span>uint64_t<span class="keyword">></span>(txn_index) << 16) + network_id;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html">std::stringstream</a> buffer;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  buffer << <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/manip/hex.html">std::hex</a> << <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/manip/uppercase.html">std::uppercase</a> << <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/manip/setfill.html">std::setfill</a>(<span class="charliteral">'0'</span>) << <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/manip/setw.html">std::setw</a>(16)</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  << ctidValue;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> {buffer.<a class="codeRef" href="http://en.cppreference.com/w/cpp/io/basic_stringstream/str.html">str</a>()};</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> }</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">inline</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<std::tuple<uint32_t, uint16_t, uint16_t></a>></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#ae8f1a8d1097638e3dca9ef69418c8c67"> 54</a></span> <a class="code" href="namespaceripple_1_1RPC.html#ae8f1a8d1097638e3dca9ef69418c8c67">decodeCTID</a>(<span class="keyword">const</span> T ctid) noexcept</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  uint64_t ctidValue{0};</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> constexpr (</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::is_same_v<T, std::string> || std::is_same_v<T, char*> ||</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::is_same_v<T, const char*> || std::is_same_v<T, std::string_view>)</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span> ctidString(ctid);</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">if</span> (ctidString.<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string/size.html">length</a>() != 16)</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> {};</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">if</span> (!boost::regex_match(ctidString, boost::regex(<span class="stringliteral">"^[0-9A-F]+$"</span>)))</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> {};</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  ctidValue = <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string/stoul.html">std::stoull</a>(ctidString, <span class="keyword">nullptr</span>, 16);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> constexpr (std::is_integral_v<T>)</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  ctidValue = ctid;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">else</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> {};</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">if</span> ((ctidValue & 0xF000<span class="stringliteral">'0000'</span>0000<span class="stringliteral">'0000ULL) != 0xC000'</span>0000<span class="stringliteral">'0000'</span>0000ULL)</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">return</span> {};</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  uint32_t ledger_seq = (ctidValue >> 32) & 0xFFFF<span class="stringliteral">'FFFUL;</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="stringliteral"> uint16_t txn_index = (ctidValue >> 16) & 0xFFFFU;</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="stringliteral"> uint16_t network_id = ctidValue & 0xFFFFU;</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="stringliteral"> return {{ledger_seq, txn_index, network_id}};</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="stringliteral">}</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="stringliteral"></span> </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="stringliteral">} // namespace RPC</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="stringliteral">} // namespace ripple</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="stringliteral"></span> </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="stringliteral">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="asstream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/sstream.html">sstream</a></div></div>
|
|
<div class="ttc" id="aregex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/regex.html">regex</a></div></div>
|
|
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="astoul_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/stoul.html">std::stoull</a></div><div class="ttdeci">T stoull(T... args)</div></div>
|
|
<div class="ttc" id="asize_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/size.html">std::string::length</a></div><div class="ttdeci">T length(T... args)</div></div>
|
|
<div class="ttc" id="abasic_stringstream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html">std::stringstream</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="asetfill_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/setfill.html">std::setfill</a></div><div class="ttdeci">T setfill(T... args)</div></div>
|
|
<div class="ttc" id="ahex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/hex.html">std::hex</a></div><div class="ttdeci">T hex(T... args)</div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1RPC_html_ae8f1a8d1097638e3dca9ef69418c8c67"><div class="ttname"><a href="namespaceripple_1_1RPC.html#ae8f1a8d1097638e3dca9ef69418c8c67">ripple::RPC::decodeCTID</a></div><div class="ttdeci">std::optional< std::tuple< uint32_t, uint16_t, uint16_t > > decodeCTID(const T ctid) noexcept</div><div class="ttdef"><b>Definition:</b> <a href="CTID_8h_source.html#l00054">CTID.h:54</a></div></div>
|
|
<div class="ttc" id="auppercase_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/uppercase.html">std::uppercase</a></div><div class="ttdeci">T uppercase(T... args)</div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1RPC_html_a1832b06f613fc4f81a5183c79656e047"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a1832b06f613fc4f81a5183c79656e047">ripple::RPC::encodeCTID</a></div><div class="ttdeci">std::optional< std::string > encodeCTID(uint32_t ledger_seq, uint16_t txn_index, uint16_t network_id) noexcept</div><div class="ttdef"><b>Definition:</b> <a href="CTID_8h_source.html#l00034">CTID.h:34</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="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a></div></div>
|
|
<div class="ttc" id="astr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_stringstream/str.html">std::stringstream::str</a></div><div class="ttdeci">T str(T... args)</div></div>
|
|
<div class="ttc" id="asetw_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/setw.html">std::setw</a></div><div class="ttdeci">T setw(T... args)</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|