class documentation

class twisted.names.dns.RRHeader(tputil.FancyEqMixin): (source)

Implements interfaces: twisted.names.dns.IEncodable

View In Hierarchy

A resource record header.

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

Inherited from FancyEqMixin:

Method __eq__ Undocumented
Method __ne__ Undocumented
str specifying the byte format of an RR.
(type: str)
name = (source)
The name about which this reply contains information.
(type: Name)
type = (source)
The query type of the original request.
(type: int)
The query class of the original request.
The time-to-live for this record.
(type: int)
payload = (source)
The record described by this header.
(type: IEncodableRecord or None)
auth = (source)
A bool indicating whether this RRHeader was parsed from an authoritative message.
compareAttributes = (source)

Undocumented

(type: tuple[str, ...])
rdlength = (source)

Undocumented

cachedResponse = (source)

Undocumented

def __init__(self, name=b'', type=A, cls=IN, ttl=0, payload=None, auth=False): (source)
ParametersnameSee RRHeader.name (type: bytes or str)
typeThe query type. (type: int)
clsThe query class. (type: int)
ttlTime to live for this record. This will be converted to an int. (type: int)
payloadAn optional Query Type specific data object. (type: IEncodableRecord or None)
authUndocumented (type: bool)
RaisesTypeErrorif the ttl cannot be converted to an int.
ValueErrorif the ttl is negative.
ValueErrorif the payload type is not equal to the type argument.
def encode(self, strio, compDict=None): (source)

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

ParametersstrioThe buffer to write to. It must have a tell() method. (type: File-like object)
compDictA 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)

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

ParametersstrioA seekable buffer from which bytes may be read. (type: File-like object)
lengthThe 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 isAuthoritative(self): (source)

Undocumented

def __str__(self): (source)

Undocumented

ReturnsUndocumented (type: str)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.