aboutsummaryrefslogtreecommitdiff
path: root/docs/dns.html
diff options
context:
space:
mode:
authorCaleb Maclennan <caleb@alerque.com>2023-11-10 09:12:04 +0300
committerCaleb Maclennan <caleb@alerque.com>2023-11-10 09:12:04 +0300
commit5c4fc93d5f4137bf4c22ddf1a048c907a4a26727 (patch)
treea9a68e1f6a9c3bfe2b64fa1c3a4098865b7d3b5d /docs/dns.html
parentccef3bc4e2aa6ee5b997a80aabb58f4ff0b0e98f (diff)
parent43a97b7f0053313b43906371dbdc226271e6c8ab (diff)
downloadluasocket-hjelmeland-patch-1.tar.gz
luasocket-hjelmeland-patch-1.tar.bz2
luasocket-hjelmeland-patch-1.zip
Merge branch 'master' into hjelmeland-patch-1hjelmeland-patch-1
Diffstat (limited to 'docs/dns.html')
-rw-r--r--docs/dns.html183
1 files changed, 183 insertions, 0 deletions
diff --git a/docs/dns.html b/docs/dns.html
new file mode 100644
index 0000000..56ce3ba
--- /dev/null
+++ b/docs/dns.html
@@ -0,0 +1,183 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4
5<head>
6<meta name="description" content="LuaSocket: DNS support">
7<meta name="keywords" content="Lua, LuaSocket, DNS, Network, Library, Support">
8<title>LuaSocket: DNS support</title>
9<link rel="stylesheet" href="reference.css" type="text/css">
10</head>
11
12<body>
13
14<!-- header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
15
16<div class="header">
17<hr>
18<center>
19<table summary="LuaSocket logo">
20<tr><td align="center"><a href="http://www.lua.org">
21<img width="128" height="128" border="0" alt="LuaSocket" src="luasocket.png">
22</a></td></tr>
23<tr><td align="center" valign="top">Network support for the Lua language
24</td></tr>
25</table>
26<p class="bar">
27<a href="index.html">home</a> &middot;
28<a href="index.html#download">download</a> &middot;
29<a href="installation.html">installation</a> &middot;
30<a href="introduction.html">introduction</a> &middot;
31<a href="reference.html">reference</a>
32</p>
33</center>
34<hr>
35</div>
36
37<!-- dns ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
38
39<h2 id="dns">DNS</h2>
40
41<p>
42IPv4 name resolution functions
43<a href="#toip"><tt>dns.toip</tt></a>
44and
45<a href="#tohostname"><tt>dns.tohostname</tt></a>
46return <em>all</em> information obtained from
47the resolver in a table of the form:
48</p>
49
50<blockquote><tt>
51resolved4 = {<br>
52&nbsp;&nbsp;name = <i>canonic-name</i>,<br>
53&nbsp;&nbsp;alias = <i>alias-list</i>,<br>
54&nbsp;&nbsp;ip = <i>ip-address-list</i><br>
55}
56</tt> </blockquote>
57
58<p>
59Note that the <tt>alias</tt> list can be empty.
60</p>
61
62<p>
63The more general name resolution function
64<a href="#getaddrinfo"><tt>dns.getaddrinfo</tt></a>, which
65supports both IPv6 and IPv4,
66returns <em>all</em> information obtained from
67the resolver in a table of the form:
68</p>
69
70<blockquote><tt>
71resolved6 = {<br>
72&nbsp;&nbsp;[1] = {<br>
73&nbsp;&nbsp;&nbsp;&nbsp;family = <i>family-name-1</i>,<br>
74&nbsp;&nbsp;&nbsp;&nbsp;addr = <i>address-1</i><br>
75&nbsp;&nbsp;},<br>
76&nbsp;&nbsp;...<br>
77&nbsp;&nbsp;[n] = {<br>
78&nbsp;&nbsp;&nbsp;&nbsp;family = <i>family-name-n</i>,<br>
79&nbsp;&nbsp;&nbsp;&nbsp;addr = <i>address-n</i><br>
80&nbsp;&nbsp;}<br>
81}
82</tt> </blockquote>
83
84<p>
85Here, <tt>family</tt> contains the string <tt>"inet"</tt> for IPv4
86addresses, and <tt>"inet6"</tt> for IPv6 addresses.
87</p>
88
89<!-- getaddrinfo ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
90
91<p class="name" id="getaddrinfo">
92socket.dns.<b>getaddrinfo(</b>address<b>)</b>
93</p>
94
95<p class="description">
96Converts from host name to address.
97</p>
98
99<p class="parameters">
100<tt>Address</tt> can be an IPv4 or IPv6 address or host name.
101</p>
102
103<p class="return">
104The function returns a table with all information returned by
105the resolver. In case of error, the function returns <b><tt>nil</tt></b>
106followed by an error message.
107</p>
108
109<!-- gethostname ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
110
111<p class="name" id="gethostname">
112socket.dns.<b>gethostname()</b>
113</p>
114
115<p class="description">
116Returns the standard host name for the machine as a string.
117</p>
118
119<!-- tohostname +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
120
121<p class="name" id="tohostname">
122socket.dns.<b>tohostname(</b>address<b>)</b>
123</p>
124
125<p class="description">
126Converts from IPv4 address to host name.
127</p>
128
129<p class="parameters">
130<tt>Address</tt> can be an IP address or host name.
131</p>
132
133<p class="return">
134The function returns a string with the canonic host name of the given
135<tt>address</tt>, followed by a table with all information returned by
136the resolver. In case of error, the function returns <b><tt>nil</tt></b>
137followed by an error message.
138</p>
139
140<!-- toip +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
141
142<p class="name" id="toip">
143socket.dns.<b>toip(</b>address<b>)</b>
144</p>
145
146<p class="description">
147Converts from host name to IPv4 address.
148</p>
149
150<p class="parameters">
151<tt>Address</tt> can be an IP address or host name.
152</p>
153
154<p class="return">
155Returns a string with the first IP address found for <tt>address</tt>,
156followed by a table with all information returned by the resolver.
157In case of error, the function returns <b><tt>nil</tt></b> followed by an error
158message.
159</p>
160
161<!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
162
163<div class="footer">
164<hr>
165<center>
166<p class="bar">
167<a href="index.html">home</a> &middot;
168<a href="index.html#down">download</a> &middot;
169<a href="installation.html">installation</a> &middot;
170<a href="introduction.html">introduction</a> &middot;
171<a href="reference.html">reference</a>
172</p>
173<p>
174<small>
175Last modified by Diego Nehab on <br>
176Thu Apr 20 00:25:07 EDT 2006
177</small>
178</p>
179</center>
180</div>
181
182</body>
183</html>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-03-21 05:35:37 +0000