EV-ADNS/ADNS.pm

=head1 NAME

EV::ADNS - lightweight asynchronous dns queries using EV and libadns

=head1 SYNOPSIS

 use EV;
 use EV::ADNS;

 EV::ADNS::submit "example.com", EV::ADNS::r_addr, EV::ADNS::qf_cname_loose, sub {
    my ($status, $expires, @a) = @_;
    warn $a[0]; # "127.13.166.3" etc.
 };

 EV::run;

=head1 DESCRIPTION

This is a simple interface to libadns (asynchronous dns) that
integrates well and automatically into the EV event loop. The
documentation for libadns is vital to understand this module, see
L<http://www.chiark.greenend.org.uk/~ian/adns/>.

You can use it only with EV (directly or indirectly, e.g. via
L<Glib::EV>). Apart from loading and using the C<submit> function you need
not do anything (except run an EV event loop).

=head1 OVERVIEW

All the constants/enums from F<adns.h> are available in the EV::ADNS
namespace, without the C<adns_> prefix, i.e. C<adns_r_a> becomes
C<EV::ADNS::r_a> and so on.

=head1 FUNCTIONS

=over 4

=item $query = EV::ADNS::submit "domain", $rrtype, $flags, $cb

Submits a new request to be handled. See the C<adns_submit> C function
description for more details. The function optionally returns a query
object which can be used to cancel an in-progress request. You do not need
to store the query object, even if you ignore it, the query will proceed.

The callback will be invoked with a result status, the time the resource
record validity expires and zero or more resource records, one scalar per
result record. Example:

   sub adns_cb {
      my ($status, $expires, @rr) = @_;
      if ($status == EV::ADNS::s_ok) {
         use JSON::XS;
         warn encode_json \@rr;
      }
   }

The format of result records varies considerably, here is some cursory
documentation of how each record will look like, depending on the query
type:

=over 4

=item EV::ADNS::r_addr

IPv4 and/or IPV6 addresses in string form.

=item EV::ADNS::r_a

IPv4 addresses in dotted quad (string) form.

=item EV::ADNS::r_aaaa

IPv6 addresses in string form.

=item EV::ADNS::r_ns_raw, EV::ADNS::r_cname, EV::ADNS::r_ptr, EV::ADNS::r_ptr_raw

The resource record as a simple string.

=item EV::ADNS::r_txt

An arrayref of strings.

=item EV::ADNS::r_ns

A "host address", a hostname with any number of addresses (hint records).

The record will be an arrayref with domainname, adns status and any number
of associated addresses: C<< ["domain", adns_status, addr...] >>.

=item EV::ADNS::r_hinfo

An arrayref consisting of the two strings.

=item EV::ADNS::r_rp, EV::ADNS::r_rp_raw

An arrayref with two strings.

=item EV::ADNS::r_mx

An arrayref consisting of the priority and a "host address" (see
C<EV::ADNS::r_ns>). Example:

   [10, [["alt3.aspmx.l.google.com", 0, "64.233.189.27", "2404:6800:4008:c07::1a"]]]

=item EV::ADNS::r_mx_raw

An arrayref consisting of the priority and the hostname, e.g. C<[10,
"mail.example.com"]>.

=item EV::ADNS::r_soa, EV::ADNS::r_soa_raw

An arrayref consisting of the primary nameserver, admin name, serial,
refresh, retry expire and minimum times, e.g.:

  ["ns.example.net", "hostmaster@example.net", 2000001102, 86400, 21600, 2592000, 172800]

The "raw" form doesn't mangle the e-mail address.

=item EV::ADNS::r_srv_raw

An arrayref consisting of the priority, weight, port and hostname, e.g.:

   [10, 10, 5060, "sip1.example.net"]

=item EV::ADNS::r_srv

The same as C<EV::ADNS::r_srv_raw>, but the hostname is replaced by a "host
address" (see C<EV::ADNS::r_ns>).

=item EV::ADNS::r_unknown

A single octet string with the raw contents.

=item anything else

Currently C<undef>.

=back

=item $query->cancel

Cancels a request that is in progress.

=item EV::ADNS::reinit $flags_or_undef, $resolvdata_or_undef

Cancels all outstanding queries, frees all adns state and reinitialises
it. It is highly recommended to only call this when there are no
outstanding requests.

The first argument is the set of init flags to use, or C<undef>, in which
case EV::ADNS uses it's default flag set.

The second argument can be missing or C<undef>; in which case the normal
initialisation is done (such as reading the F<resolv.conf>), or it might
be a stirng, in which case no config files or environment variables will
be read and the given string will be interpreted as the F<resolv.conf>
contents.

=back

=cut

package EV::ADNS;

use Carp ();
use EV ();

BEGIN {
   $VERSION = '3.0';

   require XSLoader;
   XSLoader::load (EV::ADNS, $VERSION);
}

=head1 SEE ALSO

L<EV>, L<Net::ADNS> another interface to adns, maybe better, but without
real support to integrate it into other event loops.

=head1 AUTHOR

 Marc Lehmann <schmorp@schmorp.de>
 http://home.schmorp.de/

=cut

1

Revision:	1.16
Committed:	Sat Oct 17 00:01:53 2015 UTC (8 years, 7 months ago) by root
Branch:	MAIN
Changes since 1.15:	+3 -2 lines
Log Message:	* empty log message *
#	Content
1	=head1 NAME
2
3	EV::ADNS - lightweight asynchronous dns queries using EV and libadns
4
5	=head1 SYNOPSIS
6
7	use EV;
8	use EV::ADNS;
9
10	EV::ADNS::submit "example.com", EV::ADNS::r_addr, EV::ADNS::qf_cname_loose, sub {
11	my ($status, $expires, @a) = @_;
12	warn $a[0]; # "127.13.166.3" etc.
13	};
14
15	EV::run;
16
17	=head1 DESCRIPTION
18
19	This is a simple interface to libadns (asynchronous dns) that
20	integrates well and automatically into the EV event loop. The
21	documentation for libadns is vital to understand this module, see
22	L<http://www.chiark.greenend.org.uk/~ian/adns/>.
23
24	You can use it only with EV (directly or indirectly, e.g. via
25	L<Glib::EV>). Apart from loading and using the C<submit> function you need
26	not do anything (except run an EV event loop).
27
28	=head1 OVERVIEW
29
30	All the constants/enums from F<adns.h> are available in the EV::ADNS
31	namespace, without the C<adns_> prefix, i.e. C<adns_r_a> becomes
32	C<EV::ADNS::r_a> and so on.
33
34	=head1 FUNCTIONS
35
36	=over 4
37
38	=item $query = EV::ADNS::submit "domain", $rrtype, $flags, $cb
39
40	Submits a new request to be handled. See the C<adns_submit> C function
41	description for more details. The function optionally returns a query
42	object which can be used to cancel an in-progress request. You do not need
43	to store the query object, even if you ignore it, the query will proceed.
44
45	The callback will be invoked with a result status, the time the resource
46	record validity expires and zero or more resource records, one scalar per
47	result record. Example:
48
49	sub adns_cb {
50	my ($status, $expires, @rr) = @_;
51	if ($status == EV::ADNS::s_ok) {
52	use JSON::XS;
53	warn encode_json \@rr;
54	}
55	}
56
57	The format of result records varies considerably, here is some cursory
58	documentation of how each record will look like, depending on the query
59	type:
60
61	=over 4
62
63	=item EV::ADNS::r_addr
64
65	IPv4 and/or IPV6 addresses in string form.
66
67	=item EV::ADNS::r_a
68
69	IPv4 addresses in dotted quad (string) form.
70
71	=item EV::ADNS::r_aaaa
72
73	IPv6 addresses in string form.
74
75	=item EV::ADNS::r_ns_raw, EV::ADNS::r_cname, EV::ADNS::r_ptr, EV::ADNS::r_ptr_raw
76
77	The resource record as a simple string.
78
79	=item EV::ADNS::r_txt
80
81	An arrayref of strings.
82
83	=item EV::ADNS::r_ns
84
85	A "host address", a hostname with any number of addresses (hint records).
86
87	The record will be an arrayref with domainname, adns status and any number
88	of associated addresses: C<< ["domain", adns_status, addr...] >>.
89
90	=item EV::ADNS::r_hinfo
91
92	An arrayref consisting of the two strings.
93
94	=item EV::ADNS::r_rp, EV::ADNS::r_rp_raw
95
96	An arrayref with two strings.
97
98	=item EV::ADNS::r_mx
99
100	An arrayref consisting of the priority and a "host address" (see
101	C<EV::ADNS::r_ns>). Example:
102
103	[10, [["alt3.aspmx.l.google.com", 0, "64.233.189.27", "2404:6800:4008:c07::1a"]]]
104
105	=item EV::ADNS::r_mx_raw
106
107	An arrayref consisting of the priority and the hostname, e.g. C<[10,
108	"mail.example.com"]>.
109
110	=item EV::ADNS::r_soa, EV::ADNS::r_soa_raw
111
112	An arrayref consisting of the primary nameserver, admin name, serial,
113	refresh, retry expire and minimum times, e.g.:
114
115	["ns.example.net", "hostmaster@example.net", 2000001102, 86400, 21600, 2592000, 172800]
116
117	The "raw" form doesn't mangle the e-mail address.
118
119	=item EV::ADNS::r_srv_raw
120
121	An arrayref consisting of the priority, weight, port and hostname, e.g.:
122
123	[10, 10, 5060, "sip1.example.net"]
124
125	=item EV::ADNS::r_srv
126
127	The same as C<EV::ADNS::r_srv_raw>, but the hostname is replaced by a "host
128	address" (see C<EV::ADNS::r_ns>).
129
130	=item EV::ADNS::r_unknown
131
132	A single octet string with the raw contents.
133
134	=item anything else
135
136	Currently C<undef>.
137
138	=back
139
140	=item $query->cancel
141
142	Cancels a request that is in progress.
143
144	=item EV::ADNS::reinit $flags_or_undef, $resolvdata_or_undef
145
146	Cancels all outstanding queries, frees all adns state and reinitialises
147	it. It is highly recommended to only call this when there are no
148	outstanding requests.
149
150	The first argument is the set of init flags to use, or C<undef>, in which
151	case EV::ADNS uses it's default flag set.
152
153	The second argument can be missing or C<undef>; in which case the normal
154	initialisation is done (such as reading the F<resolv.conf>), or it might
155	be a stirng, in which case no config files or environment variables will
156	be read and the given string will be interpreted as the F<resolv.conf>
157	contents.
158
159	=back
160
161	=cut
162
163	package EV::ADNS;
164
165	use Carp ();
166	use EV ();
167
168	BEGIN {
169	$VERSION = '3.0';
170
171	require XSLoader;
172	XSLoader::load (EV::ADNS, $VERSION);
173	}
174
175	=head1 SEE ALSO
176
177	L<EV>, L<Net::ADNS> another interface to adns, maybe better, but without
178	real support to integrate it into other event loops.
179
180	=head1 AUTHOR
181
182	Marc Lehmann <schmorp@schmorp.de>
183	http://home.schmorp.de/
184
185	=cut
186
187	1
188