.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::DNS::RR::SOA 3"
.TH Net::DNS::RR::SOA 3 "2016-05-27" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::DNS::RR::SOA \- DNS SOA resource record
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Net::DNS;
\&    $rr = new Net::DNS::RR(\*(Aqname SOA mname rname 0 14400 3600 1814400 3600\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Class for \s-1DNS\s0 Start of Authority (\s-1SOA\s0) resource records.
.SH "METHODS"
.IX Header "METHODS"
The available methods are those inherited from the base class augmented
by the type-specific methods defined in this package.
.PP
Use of undocumented package features or direct access to internal data
structures is discouraged and could result in program termination or
other unpredictable behaviour.
.SS "mname"
.IX Subsection "mname"
.Vb 2
\&    $mname = $rr\->mname;
\&    $rr\->mname( $mname );
.Ve
.PP
The domain name of the name server that was the
original or primary source of data for this zone.
.SS "rname"
.IX Subsection "rname"
.Vb 2
\&    $rname = $rr\->rname;
\&    $rr\->rname( $rname );
.Ve
.PP
The mailbox which identifies the person responsible
for maintaining this zone.
.SS "serial"
.IX Subsection "serial"
.Vb 2
\&    $serial = $rr\->serial;
\&    $serial = $rr\->serial(value);
.Ve
.PP
Unsigned 32 bit version number of the original copy of the zone.
Zone transfers preserve this value.
.PP
\&\s-1RFC1982\s0 defines a strict (irreflexive) partial ordering for zone
serial numbers. The serial number will be incremented unless the
replacement value argument satisfies the ordering constraint.
.SS "refresh"
.IX Subsection "refresh"
.Vb 2
\&    $refresh = $rr\->refresh;
\&    $rr\->refresh( $refresh );
.Ve
.PP
A 32 bit time interval before the zone should be refreshed.
.SS "retry"
.IX Subsection "retry"
.Vb 2
\&    $retry = $rr\->retry;
\&    $rr\->retry( $retry );
.Ve
.PP
A 32 bit time interval that should elapse before a
failed refresh should be retried.
.SS "expire"
.IX Subsection "expire"
.Vb 2
\&    $expire = $rr\->expire;
\&    $rr\->expire( $expire );
.Ve
.PP
A 32 bit time value that specifies the upper limit on
the time interval that can elapse before the zone is no
longer authoritative.
.SS "minimum"
.IX Subsection "minimum"
.Vb 2
\&    $minimum = $rr\->minimum;
\&    $rr\->minimum( $minimum );
.Ve
.PP
The unsigned 32 bit minimum \s-1TTL\s0 field that should be
exported with any \s-1RR\s0 from this zone.
.SH "Zone Serial Number Management"
.IX Header "Zone Serial Number Management"
The internal logic of the \fIserial()\fR method offers support for several
widely used zone serial numbering policies.
.SS "Strictly Sequential"
.IX Subsection "Strictly Sequential"
.Vb 1
\&    $successor = $soa\->serial( SEQUENTIAL );
.Ve
.PP
The existing serial number is incremented modulo 2**32 because the
value returned by the auxiliary \s-1\fISEQUENTIAL\s0()\fR function can never
satisfy the serial number ordering constraint.
.SS "Date Encoded"
.IX Subsection "Date Encoded"
.Vb 1
\&    $successor = $soa\->serial( YYYYMMDDxx );
.Ve
.PP
The 32 bit value returned by the auxiliary \fIYYYYMMDDxx()\fR function will
be used if it satisfies the ordering constraint, otherwise the serial
number will be incremented as above.
.PP
Serial number increments must be limited to 100 per day for the date
information to remain useful.
.SS "Time Encoded"
.IX Subsection "Time Encoded"
.Vb 1
\&    $successor = $soa\->serial( UNIXTIME );
.Ve
.PP
The 32 bit value returned by the auxiliary \s-1\fIUNIXTIME\s0()\fR function will
used if it satisfies the ordering constraint, otherwise the existing
serial number will be incremented as above.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c)1997 Michael Fuhr.
.PP
Portions Copyright (c)2003 Chris Reinhardt.
.PP
Portions Copyright (c)2010,2012 Dick Franks.
.PP
All rights reserved.
.PP
Package template (c)2009,2012 O.M.Kolkman and R.W.Franks.
.SH "LICENSE"
.IX Header "LICENSE"
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted, provided
that the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation, and that the name of the author not be used in advertising
or publicity pertaining to distribution of the software without specific
prior written permission.
.PP
\&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl, Net::DNS, Net::DNS::RR, \s-1RFC1035\s0 Section 3.3.13, \s-1RFC1982\s0