Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`names`.`dns`.`Record_SOA``

class documentation

`class Record_SOA(tputil.FancyEqMixin, tputil.FancyStrMixin): (source)`

Implements interfaces: `twisted.names.dns.IEncodableRecord`

View In Hierarchy

Marks the start of a zone of authority.

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

Method | `__hash__` | Undocumented
Method | `__init__` | No summary
Method | `decode` | Reconstruct an object from data read from the given file object.
Method | `encode` | Write a representation of this object to the given file object.
Class Variable | `compareAttributes` | Undocumented
Class Variable | `fancybasename` | Undocumented
Class Variable | `showAttributes` | Undocumented
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 | `minimum` | The unsigned 32 bit minimum TTL field that should be exported with any RR from this 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 | `refresh` | A 32 bit time interval before the zone should be refreshed.
Instance Variable | `retry` | A 32 bit time interval that should elapse before a failed refresh should be retried.
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 | `ttl` | The default TTL to use for records served from this zone.

Inherited from `FancyEqMixin`:

Method | `__eq__` | Undocumented
Method | `__ne__` | Undocumented

Inherited from `FancyStrMixin` (via `FancyEqMixin`):

Method | `__str__` | Undocumented

def __hash__(self): (source)

Undocumented

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

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

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:File-like object | A seekable buffer from which bytes may be read.
length:`int` or `None` | 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.

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:File-like object | The buffer to write to. It must have a `tell()` method.
compDict:`dict` of `bytes` to `int` r `None` | 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.

compareAttributes: `tuple[str, ...]` = (source)
overrides `twisted.python.util.FancyEqMixin.compareAttributes`

Undocumented

fancybasename: `str` = (source)

Undocumented

showAttributes: `tuple` = (source)
overrides `twisted.python.util.FancyStrMixin.showAttributes`

Undocumented

expire: `int` = (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.

minimum: `int` = (source)

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

mname: `Name` = (source)

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

refresh: `int` = (source)

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

retry: `int` = (source)

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

rname: `Name` = (source)

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

serial: `int` = (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.

ttl: `int` = (source)

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