summaryrefslogtreecommitdiffstats
path: root/doc/README.html.in
blob: e352b139fbb8605c803eacef9c5e787489650fb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<title>libasyncns @PACKAGE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>
<h1><a name="top">libasyncns @PACKAGE_VERSION@</a></h1>

<p><i>Copyright 2004 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i></p>

<ul class="toc">
    <li><a href="#license">License</a></li>
    <li><a href="#news">News</a></li>
    <li><a href="#overview">Overview</a></li>
    <li><a href="#status">Status</a></li>
    <li><a href="#documentation">Documentation</a></li>
    <li><a href="#requirements">Requirements</a></li>
    <li><a href="#installation">Installation</a></li>
    <li><a href="#acks">Acknowledgements</a></li>
    <li><a href="#download">Download</a></li>
</ul>

<h2><a name="license">License</a></h2>

<p>This program is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.</p>

<p>This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.</p>

<p>You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>

<h2><a name="news">News</a></h2>

<div class="news-date">Fri 7 Jan 2005: </div> <p class="news-text"><a
href="@PACKAGE_URL@libasyncns-0.1.tar.gz">Version 0.1</a> released</p>

<h2><a name="overview">Overview</a></h2>

<p><tt>libasyncns</tt> is a C library for Linux/Unix for executing name
service queries asynchronously. It is an asynchronous wrapper around
<tt>getaddrinfo(3)</tt> and <tt>getnameinfo(3)</tt> from the
<tt>libc</tt>.</p>

<p>In contrast to GNU's asynchronous name resolving API
<tt>getaddrinfo_a()</tt>, <tt>libasyncns</tt> does not make use of
UNIX signals for reporting completion of name queries. Instead, the
API exports a standard UNIX file descriptor which may be integerated
cleanly into custom main loops.</p>

<p>In contrast to asynchronous DNS resolving libraries like <tt><a
href="http://libdenise.sourceforge.net/">libdenise</a></tt>, <tt><a
href="http://www.skarnet.org/software/skadns/">skadns</a></tt>, <tt><a
href="http://www.chiark.greenend.org.uk/~ian/adns/">adns</a></tt>,
<tt>libasyncns</tt> is just an asynchronous wrapper around the libc's
synchronous <tt>getaddrinfo()</tt> API, which has the advantage of
allowing name resolution using techniques like <a
href="http://0pointer.de/lennart/projects/nss-mdns/">Multicast
DNS</a>, LDAP or NIS using standard <tt>libc</tt> NSS (Name Service
Switch) modules. <tt>libasyncns</tt> is compatible with IPv6 if the
underlying <tt>libc</tt> is.</p>

<p><tt>libasyncns</tt> is very tiny, consisting of just one header and
one source file. It has no dependencies besides <tt>libc</tt>.</p>

<p>By default <tt>libasyncns</tt> spawns a number of worker threads
(LWPs) to process name queries. Alternatively or when POSIX Threads
are not supported, <tt>libasyncns</tt> can <tt>fork()</tt> off worker
processes instead.</p>

<h2><a name="status">Status</a></h2>

<p>Version @PACKAGE_VERSION@ is quite stable and feature complete.</p>

<h2><a name="documentation">Documentation</a></h2>

<p>You may browse the <a href="http://www.doxygen.org/">Doxygen</a>
generated <a
href="http://0pointer.de/lennart/projects/libasyncns/doxygen/">programing
documentation</a> the API. (Run <tt>make doxygen</tt> to generate this
documentation from the source tree)</p>

<h2><a name="requirements">Requirements</a></h2>

<p>Currently, <tt>libasyncns</tt> is tested on Linux and Solaris (<tt>sparc-sun-solaris2.8</tt>) only.</p>

<p><tt>libasyncns</tt> was developed and tested on Debian GNU/Linux
"testing" from January 2005, it should work on most other Linux
distributions (and maybe Unix versions) since it uses GNU autoconf and
GNU libtool for source code configuration and shared library
management.</p>

<p><tt>libasyncns</tt> has no dependencies besides a <tt>libc</tt> that supports <tt>getaddrinfo()</tt>.</p>
 
<h2><a name="installation">Installation</a></h2>

<p>As this package is made with the GNU autotools you should run
<tt>./configure</tt> inside the distribution directory for configuring
the source tree. After that you should run <tt>make</tt> for
compilation and <tt>make install</tt> (as root) for installation of
<tt>libasyncns</tt>.</p>

<h2><a name="acks">Acknowledgements</a></h2>

<p>None so far</p>

<h2><a name="download">Download</a></h2>

<p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>

<p>The current release is <a href="@PACKAGE_URL@libasyncns-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>

<p>Get <tt>libasyncns</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="svn://seth.intheinter.net/libasyncns">repository</a> (<a href="http://0pointer.de/cgi-bin/viewcvs.cgi/?root=libasyncns">viewcvs</a>): </p>

<pre>svn checkout svn://seth.intheinter.net/libasyncns/trunk libasyncns</pre>

<p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="http://freshmeat.net/projects/libasyncns/">Freshmeat</a>.</p>

<hr/>
<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, January 2005</address>
<div class="grey"><i>$Id$</i></div>

</body>
</html>