Files
rippled/classripple_1_1Resolver.html
2020-04-24 01:09:47 +00:00

334 lines
17 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: ripple::Resolver 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 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1Resolver.html">Resolver</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="classripple_1_1Resolver-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::Resolver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ripple::Resolver:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Resolver__inherit__graph.png" border="0" usemap="#ripple_1_1Resolver_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1Resolver_inherit__map" id="ripple_1_1Resolver_inherit__map">
<area shape="rect" title=" " alt="" coords="34,5,157,32"/>
<area shape="rect" href="classripple_1_1ResolverAsio.html" title=" " alt="" coords="20,80,171,107"/>
<area shape="rect" href="classripple_1_1ResolverAsioImpl.html" title=" " alt="" coords="5,155,185,181"/>
</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 name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a2f2274e619a3c7b9a0e9993bcc387202"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resolver.html#a2f2274e619a3c7b9a0e9993bcc387202">HandlerType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void(<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="el" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a> &gt;)&gt;</td></tr>
<tr class="separator:a2f2274e619a3c7b9a0e9993bcc387202"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acbc7e53c855c2a009bcab4d8fc4d64df"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resolver.html#acbc7e53c855c2a009bcab4d8fc4d64df">~Resolver</a> ()=0</td></tr>
<tr class="separator:acbc7e53c855c2a009bcab4d8fc4d64df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d2751e048dbe3fb2cd229db4d791f00"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resolver.html#a9d2751e048dbe3fb2cd229db4d791f00">stop_async</a> ()=0</td></tr>
<tr class="memdesc:a9d2751e048dbe3fb2cd229db4d791f00"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> an asynchronous stop request. <a href="classripple_1_1Resolver.html#a9d2751e048dbe3fb2cd229db4d791f00">More...</a><br /></td></tr>
<tr class="separator:a9d2751e048dbe3fb2cd229db4d791f00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbdf93b006ef3a857da30e63bf24415a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resolver.html#acbdf93b006ef3a857da30e63bf24415a">stop</a> ()=0</td></tr>
<tr class="memdesc:acbdf93b006ef3a857da30e63bf24415a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> a synchronous stop request. <a href="classripple_1_1Resolver.html#acbdf93b006ef3a857da30e63bf24415a">More...</a><br /></td></tr>
<tr class="separator:acbdf93b006ef3a857da30e63bf24415a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfe3352554c00d3ecf8535f323ce1438"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resolver.html#adfe3352554c00d3ecf8535f323ce1438">start</a> ()=0</td></tr>
<tr class="memdesc:adfe3352554c00d3ecf8535f323ce1438"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> a synchronous start request. <a href="classripple_1_1Resolver.html#adfe3352554c00d3ecf8535f323ce1438">More...</a><br /></td></tr>
<tr class="separator:adfe3352554c00d3ecf8535f323ce1438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b7ea0953f182de10d6d5818e6b26874"><td class="memTemplParams" colspan="2">template&lt;class Handler &gt; </td></tr>
<tr class="memitem:a2b7ea0953f182de10d6d5818e6b26874"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1Resolver.html#a2b7ea0953f182de10d6d5818e6b26874">resolve</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &gt; const &amp;names, Handler handler)</td></tr>
<tr class="memdesc:a2b7ea0953f182de10d6d5818e6b26874"><td class="mdescLeft">&#160;</td><td class="mdescRight">resolve all hostnames on the list <a href="classripple_1_1Resolver.html#a2b7ea0953f182de10d6d5818e6b26874">More...</a><br /></td></tr>
<tr class="separator:a2b7ea0953f182de10d6d5818e6b26874"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a332312c8185e4fc4ab589677b0c168d8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resolver.html#a332312c8185e4fc4ab589677b0c168d8">resolve</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &gt; const &amp;names, <a class="el" href="classripple_1_1Resolver.html#a2f2274e619a3c7b9a0e9993bcc387202">HandlerType</a> const &amp;handler)=0</td></tr>
<tr class="separator:a332312c8185e4fc4ab589677b0c168d8"><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="Resolver_8h_source.html#l00030">30</a> of file <a class="el" href="Resolver_8h_source.html">Resolver.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a2f2274e619a3c7b9a0e9993bcc387202"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f2274e619a3c7b9a0e9993bcc387202">&#9670;&nbsp;</a></span>HandlerType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1Resolver.html#a2f2274e619a3c7b9a0e9993bcc387202">ripple::Resolver::HandlerType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;void(<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt;<a class="el" href="classbeast_1_1IP_1_1Endpoint.html">beast::IP::Endpoint</a>&gt;)&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Resolver_8h_source.html#l00034">34</a> of file <a class="el" href="Resolver_8h_source.html">Resolver.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acbc7e53c855c2a009bcab4d8fc4d64df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbc7e53c855c2a009bcab4d8fc4d64df">&#9670;&nbsp;</a></span>~Resolver()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::Resolver::~Resolver </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9d2751e048dbe3fb2cd229db4d791f00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d2751e048dbe3fb2cd229db4d791f00">&#9670;&nbsp;</a></span>stop_async()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::Resolver::stop_async </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> an asynchronous stop request. </p>
<p>Implemented in <a class="el" href="classripple_1_1ResolverAsioImpl.html#ade7f4fafa443aab18dac4559c5e50894">ripple::ResolverAsioImpl</a>.</p>
</div>
</div>
<a id="acbdf93b006ef3a857da30e63bf24415a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbdf93b006ef3a857da30e63bf24415a">&#9670;&nbsp;</a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::Resolver::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> a synchronous stop request. </p>
<p>Implemented in <a class="el" href="classripple_1_1ResolverAsioImpl.html#a3ffa0c94f4294501499a2877dd964ca3">ripple::ResolverAsioImpl</a>.</p>
</div>
</div>
<a id="adfe3352554c00d3ecf8535f323ce1438"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfe3352554c00d3ecf8535f323ce1438">&#9670;&nbsp;</a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::Resolver::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> a synchronous start request. </p>
<p>Implemented in <a class="el" href="classripple_1_1ResolverAsioImpl.html#ac9abcf072a71182bca8c3764937487ee">ripple::ResolverAsioImpl</a>.</p>
</div>
</div>
<a id="a2b7ea0953f182de10d6d5818e6b26874"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b7ea0953f182de10d6d5818e6b26874">&#9670;&nbsp;</a></span>resolve() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Handler &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ripple::Resolver::resolve </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>names</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Handler&#160;</td>
<td class="paramname"><em>handler</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>resolve all hostnames on the list </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">names</td><td>the names to be resolved </td></tr>
<tr><td class="paramname">handler</td><td>the handler to call </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="Resolver_8h_source.html#l00057">57</a> of file <a class="el" href="Resolver_8h_source.html">Resolver.h</a>.</p>
</div>
</div>
<a id="a332312c8185e4fc4ab589677b0c168d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a332312c8185e4fc4ab589677b0c168d8">&#9670;&nbsp;</a></span>resolve() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::Resolver::resolve </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>names</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Resolver.html#a2f2274e619a3c7b9a0e9993bcc387202">HandlerType</a> const &amp;&#160;</td>
<td class="paramname"><em>handler</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1ResolverAsioImpl.html#a337b9267403b96792a6279dd0b231f00">ripple::ResolverAsioImpl</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- 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>