twisted.names.dns._OPTHeader : API documentation

Method	__init__	No summary
Method	name	A readonly property for accessing the `name` attribute of this record.
Method	type	A readonly property for accessing the `type` attribute of this record.
Method	encode	Encode this `_OPTHeader` instance to bytes.
Method	decode	Decode bytes into an `_OPTHeader` instance.
Class Method	fromRRHeader	A classmethod for constructing a new `_OPTHeader` from the attributes and payload of an existing `RRHeader` instance.

Inherited from FancyStrMixin:

Method

__str__

Undocumented

Inherited from FancyEqMixin:

Method	__eq__	Undocumented
Method	__ne__	Undocumented

def __init__(self, udpPayloadSize=4096, extendedRCODE=0, version=0, dnssecOK=False, options=None): (source)

Parameters	payload	The number of octets of the largest UDP payload that can be reassembled and delivered in the requestor's network stack.
	extendedRCODE	Forms 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). (type: `int`)
	version	Indicates the implementation level of the setter. Full conformance with this specification is indicated by version `0`. (type: `int`)
	dnssecOK	DNSSEC OK bit as defined by [RFC3225]. (type: `bool`)
	options	A `list` of 0 or more `_OPTVariableOption` instances. (type: `list`)

@property
def name(self): (source)

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

Returns The DNS name associated with this record. Since this is a pseudo record, the name is always an Name instance with value b'', which represents the DNS root zone.

@property
def type(self): (source)

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

Returns The DNS record type. This is a fixed value of 41 (dns.OPT for OPT Record.

def encode(self, strio, compDict=None): (source)

Encode this _OPTHeader instance to bytes.

Parameters	strio	the byte representation of this `_OPTHeader` will be written to this file. (type: `file`)
	compDict	A dictionary of backreference addresses that have have already been written to this stream and that may be used for DNS name compression. (type: `dict` or `None`)

def decode(self, strio, length=None): (source)

Decode bytes into an _OPTHeader instance.

Parameters	strio	Bytes will be read from this file until the full `_OPTHeader` is decoded. (type: `file`)
	length	Not used. (type: `int` or `None`)

@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	An `RRHeader` instance containing an `UnknownRecord` payload. (type: `RRHeader`)
Returns	An instance of `_OPTHeader`. (type: `_OPTHeader`)

t.n.d._OPTHeader(tputil.FancyStrMixin, tputil.FancyEqMixin, object) : class documentation