twisted.names.dns.Record_SOA : API documentation

class documentation

class twisted.names.dns.Record_SOA(tputil.FancyEqMixin, tputil.FancyStrMixin): (source)

Implements interfaces: twisted.names.dns.IEncodableRecord

Marks the start of a zone of authority.

This record describes parameters which are shared by all records within a particular zone.

Instance Variable	mname	The domain-name of the name server that was the original or primary source of data for this zone.
Instance Variable	rname	A domain-name which specifies the mailbox of the person responsible for this zone.
Instance Variable	serial	The unsigned 32 bit version number of the original copy of the zone. Zone transfers preserve this value. This value wraps and should be compared using sequence space arithmetic.
Instance Variable	refresh	A 32 bit time interval before the zone should be refreshed.
Instance Variable	minimum	The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone.
Instance Variable	expire	A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative.
Instance Variable	retry	A 32 bit time interval that should elapse before a failed refresh should be retried.
Instance Variable	ttl	The default TTL to use for records served from this zone.
Class Variable	fancybasename	Undocumented
Class Variable	compareAttributes	Undocumented
Class Variable	showAttributes	Undocumented
Method	__init__
Method	encode	Write a representation of this object to the given file object.
Method	decode	Reconstruct an object from data read from the given file object.
Method	__hash__	Undocumented

Inherited from FancyEqMixin:

Method	__eq__	Undocumented
Method	__ne__	Undocumented

Inherited from FancyStrMixin:

Method

__str__

Undocumented

mname = (source)

The domain-name of the name server that was the original or primary source of data for this zone.

(type: Name)

rname = (source)

A domain-name which specifies the mailbox of the person responsible for this zone.

(type: Name)

serial = (source)

The unsigned 32 bit version number of the original copy of the zone. Zone transfers preserve this value. This value wraps and should be compared using sequence space arithmetic.

(type: int)

refresh = (source)

A 32 bit time interval before the zone should be refreshed.

(type: int)

minimum = (source)

The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone.

(type: int)

expire = (source)

A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative.

(type: int)

retry = (source)

A 32 bit time interval that should elapse before a failed refresh should be retried.

(type: int)

ttl = (source)

The default TTL to use for records served from this zone.

(type: int)

fancybasename = (source)

Undocumented

(type: str)

compareAttributes = (source)

overrides twisted.python.util.FancyEqMixin.compareAttributes

Undocumented

(type: tuple[str, ...])

showAttributes = (source)

overrides twisted.python.util.FancyStrMixin.showAttributes

Undocumented

(type: tuple)

def __init__(self, mname=b'', rname=b'', serial=0, refresh=0, retry=0, expire=0, minimum=0, ttl=None): (source)

Parameters	mname	See `Record_SOA.mname` (type: `bytes` or `str`)
	rname	See `Record_SOA.rname` (type: `bytes` or `str`)
	serial	Undocumented
	refresh	Undocumented
	retry	Undocumented
	expire	Undocumented
	minimum	Undocumented
	ttl	Undocumented

def encode(self, strio, compDict=None): (source)

from twisted.names.dns.IEncodable

Write a representation of this object to the given file object.

Parameters	strio	The buffer to write to. It must have a `tell()` method. (type: File-like object)
	compDict	A mapping of names to byte offsets that have already been written to the buffer, which may be used for compression (see RFC 1035 section 4.1.4). When `None`, encode without compression. (type: `dict` of `bytes` to `int` r `None`)

def decode(self, strio, length=None): (source)

from twisted.names.dns.IEncodable

Reconstruct an object from data read from the given file object.

Parameters	strio	A seekable buffer from which bytes may be read. (type: File-like object)
	length	The number of bytes in this RDATA field. Most implementations can ignore this value. Only in the case of records similar to TXT where the total length is in no way encoded in the data is it necessary. (type: `int` or `None`)

def __hash__(self): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.