twisted.names.dns._OPTHeader

class documentation

class _OPTHeader(tputil.FancyStrMixin, tputil.FancyEqMixin): (source)

Constructor: _OPTHeader(udpPayloadSize, extendedRCODE, version, dnssecOK, options)

Implements interfaces: twisted.names.dns.IEncodable

View In Hierarchy

An OPT record header.

See Also
_OPTHeader.__init__ for documentation of other public instance attributes.
https://tools.ietf.org/html/rfc6891#section-6.1.2
Present Since
13.2
Class Method fromRRHeader A classmethod for constructing a new _OPTHeader from the attributes and payload of an existing RRHeader instance.
Method __init__ No summary
Method decode Decode bytes into an _OPTHeader instance.
Method encode Encode this _OPTHeader instance to bytes.
Class Variable compareAttributes Undocumented
Class Variable showAttributes Undocumented
Instance Variable dnssecOK Undocumented
Instance Variable extendedRCODE Undocumented
Instance Variable options Undocumented
Instance Variable udpPayloadSize Undocumented
Instance Variable version Undocumented
Property name A readonly property for accessing the name attribute of this record.
Property type A readonly property for accessing the type attribute of this record.

Inherited from FancyStrMixin:

Method __str__ Undocumented

Inherited from FancyEqMixin (via FancyStrMixin):

Method __eq__ Undocumented
Method __ne__ Undocumented
@classmethod
def fromRRHeader(cls, rrHeader): (source)

A classmethod for constructing a new _OPTHeader from the attributes and payload of an existing RRHeader instance.

Parameters
rrHeader:RRHeaderAn RRHeader instance containing an UnknownRecord payload.
Returns
_OPTHeaderAn instance of _OPTHeader.
def __init__(self, udpPayloadSize=4096, extendedRCODE=0, version=0, dnssecOK=False, options=None): (source)
Parameters
udpPayloadSize:intThe number of octets of the largest UDP payload that can be reassembled and delivered in the requestor's network stack.
extendedRCODE:intForms the upper 8 bits of extended 12-bit RCODE (together with the 4 bits defined in [RFC1035]. Note that EXTENDED-RCODE value 0 indicates that an unextended RCODE is in use (values 0 through 15).
version:intIndicates the implementation level of the setter. Full conformance with this specification is indicated by version 0.
dnssecOK:boolDNSSEC OK bit as defined by [RFC3225].
options:listA list of 0 or more _OPTVariableOption instances.
def decode(self, strio, length=None): (source)
from twisted.names.dns.IEncodable

Decode bytes into an _OPTHeader instance.

Parameters
strio:fileBytes will be read from this file until the full _OPTHeader is decoded.
length:int or NoneNot used.
def encode(self, strio, compDict=None): (source)
from twisted.names.dns.IEncodable

Encode this _OPTHeader instance to bytes.

Parameters
strio:filethe byte representation of this _OPTHeader will be written to this file.
compDict:dict or NoneA dictionary of backreference addresses that have already been written to this stream and that may be used for DNS name compression.
compareAttributes: tuple[str, ...] = (source)
overrides twisted.python.util.FancyEqMixin.compareAttributes

Undocumented

showAttributes = (source)
overrides twisted.python.util.FancyStrMixin.showAttributes

Undocumented

dnssecOK = (source)

Undocumented

extendedRCODE = (source)

Undocumented

options = (source)

Undocumented

udpPayloadSize = (source)

Undocumented

version = (source)

Undocumented

@property
name = (source)

A readonly property for accessing the name attribute of this record.

@property
type = (source)

A readonly property for accessing the type attribute of this record.