twisted.names.dns.Message : API documentation

class documentation

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

Message contains all the information represented by a single DNS request or response.

Instance Variable	id	See `__init__`
Instance Variable	answer	See `__init__`
Instance Variable	opCode	See `__init__`
Instance Variable	recDes	See `__init__`
Instance Variable	recAv	See `__init__`
Instance Variable	auth	See `__init__`
Instance Variable	rCode	See `__init__`
Instance Variable	trunc	See `__init__`
Instance Variable	maxSize	See `__init__`
Instance Variable	authenticData	See `__init__`
Instance Variable	checkingDisabled	See `__init__`
Instance Variable	queries	The queries which are being asked of or answered by DNS server.
Instance Variable	answers	Records containing the answers to `queries` if this is a response message.
Instance Variable	authority	Records containing information about the authoritative DNS servers for the names in `queries`.
Instance Variable	additional	Records containing IP addresses of host names in `answers` and `authority`.
Class Variable	compareAttributes	Undocumented
Class Variable	headerFmt	Undocumented
Class Variable	headerSize	Undocumented
Class Variable	add	Undocumented
Class Variable	ns	Undocumented
Method	__init__	No summary
Method	__repr__	Generate a repr of this `Message`.
Method	addQuery	Add another query to this Message.
Method	encode	Undocumented
Method	decode	Undocumented
Method	parseRecords	Undocumented
Method	lookupRecordType	Retrieve the `IRecord` implementation for the given record type.
Method	toStr	Encode this `Message` into a byte string in the format described by RFC 1035.
Method	fromStr	Decode a byte string in the format described by RFC 1035 into this `Message`.
Instance Variable	_flagNames	The names of attributes representing the flag header fields.
Instance Variable	_fieldNames	The names of attributes representing non-flag fixed header fields.
Instance Variable	_sectionNames	The names of attributes representing the record sections of this message.
Class Variable	_recordTypes	Undocumented

Inherited from FancyEqMixin:

Method	__eq__	Undocumented
Method	__ne__	Undocumented

id = (source)

See __init__

answer = (source)

See __init__

opCode = (source)

See __init__

recDes = (source)

See __init__

recAv = (source)

See __init__

auth = (source)

See __init__

rCode = (source)

See __init__

trunc = (source)

See __init__

maxSize = (source)

See __init__

(type: int)

authenticData = (source)

See __init__

checkingDisabled = (source)

See __init__

queries = (source)

The queries which are being asked of or answered by DNS server.

(type: list of Query)

answers = (source)

Records containing the answers to queries if this is a response message.

(type: list of RRHeader)

authority = (source)

Records containing information about the authoritative DNS servers for the names in queries.

(type: list of RRHeader)

additional = (source)

Records containing IP addresses of host names in answers and authority.

(type: list of RRHeader)

_flagNames = (source)

The names of attributes representing the flag header fields.

_fieldNames = (source)

The names of attributes representing non-flag fixed header fields.

_sectionNames = (source)

The names of attributes representing the record sections of this message.

compareAttributes = (source)

overrides twisted.python.util.FancyEqMixin.compareAttributes

Undocumented

(type: tuple[str, ...])

headerFmt = (source)

Undocumented

(type: str)

headerSize = (source)

Undocumented

add = (source)

Undocumented

ns = (source)

Undocumented

def __init__(self, id=0, answer=0, opCode=0, recDes=0, recAv=0, auth=0, rCode=OK, trunc=0, maxSize=512, authenticData=0, checkingDisabled=0): (source)

Parameters	id	A 16 bit identifier assigned by the program that generates any kind of query. This identifier is copied to the corresponding reply and can be used by the requester to match up replies to outstanding queries. (type: `int`)
	answer	A one bit field that specifies whether this message is a query (0), or a response (1). (type: `int`)
	opCode	A four bit field that specifies kind of query in this message. This value is set by the originator of a query and copied into the response. (type: `int`)
	recDes	Recursion Desired - this bit may be set in a query and is copied into the response. If RD is set, it directs the name server to pursue the query recursively. Recursive query support is optional. (type: `int`)
	recAv	Recursion Available - this bit is set or cleared in a response and denotes whether recursive query support is available in the name server. (type: `int`)
	auth	Authoritative Answer - this bit is valid in responses and specifies that the responding name server is an authority for the domain name in question section. (type: `int`)
	rCode	Undocumented (type: `0 <= int < 16`)
	trunc	A flag indicating that this message was truncated due to length greater than that permitted on the transmission channel. (type: `int`)
	maxSize	The requestor's UDP payload size is the number of octets of the largest UDP payload that can be reassembled and delivered in the requestor's network stack. (type: `int`)
	authenticData	A flag indicating in a response that all the data included in the answer and authority portion of the response has been authenticated by the server according to the policies of that server. See RFC2535 section-6.1. (type: `int`)
	checkingDisabled	A flag indicating in a query that pending (non-authenticated) data is acceptable to the resolver sending the query. See RFC2535 section-6.1.

def __repr__(self): (source)

Generate a repr of this Message.

Only includes the non-default fields and sections and only includes flags which are set. The id is always shown.

Returns The native string repr. (type: str)

def addQuery(self, name, type=ALL_RECORDS, cls=IN): (source)

Add another query to this Message.

Parameters	name	The name to query. (type: `bytes`)
	type	Query type (type: `int`)
	cls	Query class (type: `int`)

def encode(self, strio): (source)

Undocumented

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

Undocumented

def parseRecords(self, list, num, strio): (source)

Undocumented

_recordTypes = (source)

Undocumented

(type: dict)

def lookupRecordType(self, type): (source)

Retrieve the IRecord implementation for the given record type.

Parameters	type	A record type, such as `A` or `NS`. (type: `int`)
Returns	An object which implements `IRecord` or `None` if none can be found for the given type. (type: `Type[IRecord]`)

def toStr(self): (source)

Encode this Message into a byte string in the format described by RFC

Returns Undocumented (type: bytes)

def fromStr(self, str): (source)

Decode a byte string in the format described by RFC 1035 into this Message.

Parameters str bytes

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.