uvw/classuvw_1_1GetAddrInfoReq.html
2017-10-11 09:11:53 +02:00

433 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvw: uvw::GetAddrInfoReq 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">uvw
&#160;<span id="projectnumber">1.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_1_1GetAddrInfoReq.html">GetAddrInfoReq</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classuvw_1_1GetAddrInfoReq-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uvw::GetAddrInfoReq Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classuvw_1_1GetAddrInfoReq.html" title="The GetAddrInfoReq request. ">GetAddrInfoReq</a> request.
<a href="classuvw_1_1GetAddrInfoReq.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="dns_8hpp_source.html">dns.hpp</a>&gt;</code></p>
<p>Inherits uvw::Request&lt; T, U &gt;.</p>
<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:ad79227261955329b227c04212567779b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1GetAddrInfoReq.html#ad79227261955329b227c04212567779b">nodeAddrInfo</a> (std::string node, addrinfo *hints=nullptr)</td></tr>
<tr class="memdesc:ad79227261955329b227c04212567779b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Async <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. <a href="#ad79227261955329b227c04212567779b">More...</a><br /></td></tr>
<tr class="separator:ad79227261955329b227c04212567779b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a1dbef8fa0cb180ab87e008958334da"><td class="memItemLeft" align="right" valign="top">std::pair&lt; bool, std::unique_ptr&lt; addrinfo, Deleter &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1GetAddrInfoReq.html#a2a1dbef8fa0cb180ab87e008958334da">nodeAddrInfoSync</a> (std::string node, addrinfo *hints=nullptr)</td></tr>
<tr class="memdesc:a2a1dbef8fa0cb180ab87e008958334da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sync <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. <a href="#a2a1dbef8fa0cb180ab87e008958334da">More...</a><br /></td></tr>
<tr class="separator:a2a1dbef8fa0cb180ab87e008958334da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e44eb4fe6c7a6faddf2e55465dafbb1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1GetAddrInfoReq.html#a5e44eb4fe6c7a6faddf2e55465dafbb1">serviceAddrInfo</a> (std::string service, addrinfo *hints=nullptr)</td></tr>
<tr class="memdesc:a5e44eb4fe6c7a6faddf2e55465dafbb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Async <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. <a href="#a5e44eb4fe6c7a6faddf2e55465dafbb1">More...</a><br /></td></tr>
<tr class="separator:a5e44eb4fe6c7a6faddf2e55465dafbb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68f6ec4153d3399ab75ff2bf096c125f"><td class="memItemLeft" align="right" valign="top">std::pair&lt; bool, std::unique_ptr&lt; addrinfo, Deleter &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1GetAddrInfoReq.html#a68f6ec4153d3399ab75ff2bf096c125f">serviceAddrInfoSync</a> (std::string service, addrinfo *hints=nullptr)</td></tr>
<tr class="memdesc:a68f6ec4153d3399ab75ff2bf096c125f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sync <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. <a href="#a68f6ec4153d3399ab75ff2bf096c125f">More...</a><br /></td></tr>
<tr class="separator:a68f6ec4153d3399ab75ff2bf096c125f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68e0e31c9768a63370a3e1791c82992e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1GetAddrInfoReq.html#a68e0e31c9768a63370a3e1791c82992e">addrInfo</a> (std::string node, std::string service, addrinfo *hints=nullptr)</td></tr>
<tr class="memdesc:a68e0e31c9768a63370a3e1791c82992e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Async <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. <a href="#a68e0e31c9768a63370a3e1791c82992e">More...</a><br /></td></tr>
<tr class="separator:a68e0e31c9768a63370a3e1791c82992e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e6e9a31cf156af9fb72f28dcad14b5f"><td class="memItemLeft" align="right" valign="top">std::pair&lt; bool, std::unique_ptr&lt; addrinfo, Deleter &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1GetAddrInfoReq.html#a8e6e9a31cf156af9fb72f28dcad14b5f">addrInfoSync</a> (std::string node, std::string service, addrinfo *hints=nullptr)</td></tr>
<tr class="memdesc:a8e6e9a31cf156af9fb72f28dcad14b5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sync <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. <a href="#a8e6e9a31cf156af9fb72f28dcad14b5f">More...</a><br /></td></tr>
<tr class="separator:a8e6e9a31cf156af9fb72f28dcad14b5f"><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>The <a class="el" href="classuvw_1_1GetAddrInfoReq.html" title="The GetAddrInfoReq request. ">GetAddrInfoReq</a> request. </p>
<p>Wrapper for <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>.<br />
It offers either asynchronous and synchronous access methods.</p>
<p>To create a <code><a class="el" href="classuvw_1_1GetAddrInfoReq.html" title="The GetAddrInfoReq request. ">GetAddrInfoReq</a></code> through a <code><a class="el" href="classuvw_1_1Loop.html" title="The Loop class. ">Loop</a></code>, no arguments are required. </p>
<p class="definition">Definition at line <a class="el" href="dns_8hpp_source.html#l00074">74</a> of file <a class="el" href="dns_8hpp_source.html">dns.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a68e0e31c9768a63370a3e1791c82992e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68e0e31c9768a63370a3e1791c82992e">&#9670;&nbsp;</a></span>addrInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void uvw::GetAddrInfoReq::addrInfo </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">addrinfo *&#160;</td>
<td class="paramname"><em>hints</em> = <code>nullptr</code>&#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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Async <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>Either a numerical network address or a network hostname. </td></tr>
<tr><td class="paramname">service</td><td>Either a service name or a port number as a string. </td></tr>
<tr><td class="paramname">hints</td><td>Optional <code>addrinfo</code> data structure with additional address type constraints. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="dns_8hpp_source.html#l00163">163</a> of file <a class="el" href="dns_8hpp_source.html">dns.hpp</a>.</p>
</div>
</div>
<a id="a8e6e9a31cf156af9fb72f28dcad14b5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e6e9a31cf156af9fb72f28dcad14b5f">&#9670;&nbsp;</a></span>addrInfoSync()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::pair&lt;bool, std::unique_ptr&lt;addrinfo, Deleter&gt; &gt; uvw::GetAddrInfoReq::addrInfoSync </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">addrinfo *&#160;</td>
<td class="paramname"><em>hints</em> = <code>nullptr</code>&#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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sync <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>Either a numerical network address or a network hostname. </td></tr>
<tr><td class="paramname">service</td><td>Either a service name or a port number as a string. </td></tr>
<tr><td class="paramname">hints</td><td>Optional <code>addrinfo</code> data structure with additional address type constraints.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <code>std::pair</code> composed as it follows:<ul>
<li>A boolean value that is true in case of success, false otherwise.</li>
<li>A <code>std::unique_ptr&lt;addrinfo, Deleter&gt;</code> containing the data requested. </li>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="dns_8hpp_source.html#l00180">180</a> of file <a class="el" href="dns_8hpp_source.html">dns.hpp</a>.</p>
</div>
</div>
<a id="ad79227261955329b227c04212567779b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad79227261955329b227c04212567779b">&#9670;&nbsp;</a></span>nodeAddrInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void uvw::GetAddrInfoReq::nodeAddrInfo </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">addrinfo *&#160;</td>
<td class="paramname"><em>hints</em> = <code>nullptr</code>&#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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Async <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>Either a numerical network address or a network hostname. </td></tr>
<tr><td class="paramname">hints</td><td>Optional <code>addrinfo</code> data structure with additional address type constraints. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="dns_8hpp_source.html#l00110">110</a> of file <a class="el" href="dns_8hpp_source.html">dns.hpp</a>.</p>
</div>
</div>
<a id="a2a1dbef8fa0cb180ab87e008958334da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a1dbef8fa0cb180ab87e008958334da">&#9670;&nbsp;</a></span>nodeAddrInfoSync()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::pair&lt;bool, std::unique_ptr&lt;addrinfo, Deleter&gt; &gt; uvw::GetAddrInfoReq::nodeAddrInfoSync </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">addrinfo *&#160;</td>
<td class="paramname"><em>hints</em> = <code>nullptr</code>&#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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sync <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>Either a numerical network address or a network hostname. </td></tr>
<tr><td class="paramname">hints</td><td>Optional <code>addrinfo</code> data structure with additional address type constraints.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <code>std::pair</code> composed as it follows:<ul>
<li>A boolean value that is true in case of success, false otherwise.</li>
<li>A <code>std::unique_ptr&lt;addrinfo, Deleter&gt;</code> containing the data requested. </li>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="dns_8hpp_source.html#l00126">126</a> of file <a class="el" href="dns_8hpp_source.html">dns.hpp</a>.</p>
</div>
</div>
<a id="a5e44eb4fe6c7a6faddf2e55465dafbb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e44eb4fe6c7a6faddf2e55465dafbb1">&#9670;&nbsp;</a></span>serviceAddrInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void uvw::GetAddrInfoReq::serviceAddrInfo </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">addrinfo *&#160;</td>
<td class="paramname"><em>hints</em> = <code>nullptr</code>&#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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Async <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">service</td><td>Either a service name or a port number as a string. </td></tr>
<tr><td class="paramname">hints</td><td>Optional <code>addrinfo</code> data structure with additional address type constraints. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="dns_8hpp_source.html#l00136">136</a> of file <a class="el" href="dns_8hpp_source.html">dns.hpp</a>.</p>
</div>
</div>
<a id="a68f6ec4153d3399ab75ff2bf096c125f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68f6ec4153d3399ab75ff2bf096c125f">&#9670;&nbsp;</a></span>serviceAddrInfoSync()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::pair&lt;bool, std::unique_ptr&lt;addrinfo, Deleter&gt; &gt; uvw::GetAddrInfoReq::serviceAddrInfoSync </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">addrinfo *&#160;</td>
<td class="paramname"><em>hints</em> = <code>nullptr</code>&#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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sync <a href="http://linux.die.net/man/3/getaddrinfo">getaddrinfo</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">service</td><td>Either a service name or a port number as a string. </td></tr>
<tr><td class="paramname">hints</td><td>Optional <code>addrinfo</code> data structure with additional address type constraints.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <code>std::pair</code> composed as it follows:<ul>
<li>A boolean value that is true in case of success, false otherwise.</li>
<li>A <code>std::unique_ptr&lt;addrinfo, Deleter&gt;</code> containing the data requested. </li>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="dns_8hpp_source.html#l00152">152</a> of file <a class="el" href="dns_8hpp_source.html">dns.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/uvw/<a class="el" href="dns_8hpp_source.html">dns.hpp</a></li>
</ul>
</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.13
</small></address>
</body>
</html>