Net::DNS::Domain (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Net::DNS::Domain.3pm".)

NAME

Net::DNS::Domain - DNS domains

SYNOPSIS

    use Net::DNS::Domain;

    $domain = new Net::DNS::Domain('example.com');
    $name   = $domain->name;

DESCRIPTION

The Net::DNS::Domain module implements a class of abstract domain objects with associated class and instance methods.

Each domain object instance represents a single

domain which has a fixed identity throughout its lifetime.

Internally, the primary representation is a (possibly empty) list of

domain name labels, and optional link to an arbitrary origin domain object topologically closer to the root.

The computational expense of Unicode character-set conversion is partially mitigated by use of caches.

METHODS

new

    $object = new Net::DNS::Domain('example.com');

Creates a domain object which represents the

domain specified by the character string argument. The argument consists of a sequence of labels delimited by dots.

A character preceded by \ represents itself, without any special interpretation.

Arbitrary 8-bit codes can be represented by \ followed by exactly three decimal digits. Character code points are

irrespective of the character coding scheme employed by the underlying platform.

Argument string literals should be delimited by single quotes to avoid escape sequences being interpreted as octal character codes by the Perl compiler.

The character string presentation format follows the conventions for zone files described in

name

    $name = $domain->name;

Returns the domain name as a character string corresponding to the ``common interpretation'' to which

paragraph 9 alludes.

Character escape sequences are used to represent a dot inside a domain name label and the escape character itself.

Any non-printable code point is represented using the appropriate numerical escape sequence.

fqdn

    @fqdn = $domain->fqdn;

Returns a character string containing the fully qualified domain name, including the trailing dot.

xname

    $xname = $domain->xname;

Interprets an extended name containing Unicode domain name labels encoded as Punycode A-labels.

Domain names containing Unicode characters are supported if the Net::LibIDN module is installed.

label

    @label = $domain->label;

Identifies the domain by means of a list of domain labels.

string

    $string = $object->string;

Returns a character string containing the fully qualified domain name as it appears in a zone file.

Characters which are recognised by

zone file syntax are represented by the appropriate escape sequence.

origin

    $create = origin Net::DNS::Domain( $ORIGIN );
    $result = &$create( sub{ new Net::DNS::RR( 'mx MX 10 a' ); } );
    $expect = new Net::DNS::RR( "mx.$ORIGIN. MX 10 a.$ORIGIN." );

Class method which returns a reference to a subroutine wrapper which executes a given constructor in a dynamically scoped context where relative names become descendents of the specified $ORIGIN.

BUGS

Coding strategy is intended to avoid creating unnecessary argument lists and stack frames. This improves efficiency at the expense of code readability.

Platform specific character coding features are conditionally compiled into the code.

COPYRIGHT

Copyright (c)2009-2011 Dick Franks.

All rights reserved.

This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

perl, Net::LibIDN, Net::DNS, Unicode Technical Report #16