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`.`RRHeader``

class documentation

`class RRHeader(tputil.FancyEqMixin): (source)`

Constructor: `RRHeader(name, type, cls, ttl, ...)`

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

View In Hierarchy

A resource record header.

Method | `__init__` | No summary
Method | `__str__` | Undocumented
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.
Method | `isAuthoritative` | Undocumented
Class Variable | `cachedResponse` | Undocumented
Class Variable | `compareAttributes` | Undocumented
Class Variable | `fmt` | `str` specifying the byte format of an RR.
Instance Variable | `auth` | A `bool` indicating whether this `RRHeader` was parsed from an authoritative message.
Instance Variable | `cls` | The query class of the original request.
Instance Variable | `name` | The name about which this reply contains information.
Instance Variable | `payload` | The record described by this header.
Instance Variable | `rdlength` | Undocumented
Instance Variable | `ttl` | The time-to-live for this record.
Instance Variable | `type` | The query type of the original request.

Inherited from `FancyEqMixin`:

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

def __init__(self, name: `Union[bytes, str]` = b'', type: `int` = A, cls: `int` = IN, ttl: `SupportsInt` = 0, payload: `Optional[IEncodableRecord]` = None, auth: `bool` = False): (source)

Parameters
name:`bytes` or `str` | See `RRHeader.name`
type:`int` | The query type.
cls:`int` | The query class.
ttl:`int` | Time to live for this record. This will be converted to an `int`.
payload:`IEncodableRecord` or `None` | An optional Query Type specific data object.
auth:`bool` | Undocumented
Raises
`TypeError` | if the ttl cannot be converted to an `int`.
`ValueError` | if the ttl is negative.
`ValueError` | if the payload type is not equal to the `type` argument.

def __str__(self) -> `str`: (source)

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.

def isAuthoritative(self): (source)

Undocumented

cachedResponse = (source)

Undocumented

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

Undocumented

fmt: `str` = (source)

`str` specifying the byte format of an RR.

auth = (source)

A `bool` indicating whether this `RRHeader` was parsed from an authoritative message.

cls = (source)

The query class of the original request.

name: `Name` = (source)

The name about which this reply contains information.

payload: `IEncodableRecord` or `None` = (source)

The record described by this header.

rdlength = (source)

Undocumented

ttl: `int` = (source)

The time-to-live for this record.

type: `int` = (source)

The query type of the original request.