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 strSee RRHeader.name
type:intThe query type.
cls:intThe query class.
ttl:intTime to live for this record. This will be converted to an int.
payload:IEncodableRecord or NoneAn optional Query Type specific data object.
auth:boolUndocumented
Raises
TypeErrorif 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 __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 objectA seekable buffer from which bytes may be read.
length:int or NoneThe 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 objectThe buffer to write to. It must have a tell() method.
compDict:dict of bytes to int r NoneA 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.