Net::DNS::Domain(3)

NAME
Net::DNS::Domain - Domain Name System 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 DNS domain objects with associated class and instance methods.

Each domain object instance represents a single DNS domain which has a fixed identity throughout its lifetime.

Internally, the primary representation is a (possibly empty) list of ASCII domain name labels, and optional link to an arbitrary origin domain object topologically closer to the DNS root.

The presentation form of the domain name is generated on demand and the result cached within the object.

METHODS

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

Creates a domain object which represents the DNS 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 ASCII, 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 RFC1035.

  name
    $name = $domain->name;

Returns the domain name as a character string corresponding to the "common interpretation" to which RFC1034, 3.1, paragraph 9 alludes.

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

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

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.

  identifier
    $identifier = $domain->identifier;

Identifies the domain by means of its uninterpreted A-label form of domain name.

  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 RFC1035 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 will execute a given constructor in a context within which $ORIGIN is defined.

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, RFC1034, RFC1035, RFC5891, Unicode Technical Report #16