io.netty.handler.codec.dns

Interface DnsMessage

All Superinterfaces:

io.netty.util.ReferenceCounted

All Known Subinterfaces:

DnsQuery, DnsResponse

All Known Implementing Classes:

AbstractDnsMessage, DatagramDnsQuery, DatagramDnsResponse, DefaultDnsQuery, DefaultDnsResponse

public interface DnsMessage
extends io.netty.util.ReferenceCounted

The superclass which contains core information concerning a DnsQuery and a DnsResponse.

Method Summary

Modifier and Type	Method and Description
DnsMessage	addRecord(DnsSection section, DnsRecord record) Adds the specified record at the end of the specified section of this DNS message.
DnsMessage	addRecord(DnsSection section, int index, DnsRecord record) Adds the specified record at the specified index of the specified section of this DNS message.
DnsMessage	clear() Removes all the records in this DNS message.
DnsMessage	clear(DnsSection section) Removes all the records in the specified section of this DNS message.
int	count() Returns the number of records in this DNS message.
int	count(DnsSection section) Returns the number of records in the specified section of this DNS message.
int	id() Returns the ID of this DNS message.
boolean	isRecursionDesired() Returns the RD (recursion desired} field of this DNS message.
DnsOpCode	opCode() Returns the opCode of this DNS message.
<T extends DnsRecord> T	recordAt(DnsSection section) Returns the first record in the specified section of this DNS message.
<T extends DnsRecord> T	recordAt(DnsSection section, int index) Returns the record at the specified index of the specified section of this DNS message.
<T extends DnsRecord> T	removeRecord(DnsSection section, int index) Removes the record at the specified index of the specified section from this DNS message.
DnsMessage	retain()
DnsMessage	retain(int increment)
DnsMessage	setId(int id) Sets the ID of this DNS message.
DnsMessage	setOpCode(DnsOpCode opCode) Sets the opCode of this DNS message.
DnsMessage	setRecord(DnsSection section, DnsRecord record) Sets the specified section of this DNS message to the specified record, making it a single-record section.
<T extends DnsRecord> T	setRecord(DnsSection section, int index, DnsRecord record) Sets the specified record at the specified index of the specified section of this DNS message.
DnsMessage	setRecursionDesired(boolean recursionDesired) Sets the RD (recursion desired} field of this DNS message.
DnsMessage	setZ(int z) Sets the Z (reserved for future use) field of this DNS message.
int	z() Returns the Z (reserved for future use) field of this DNS message.

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Method Detail

id

int id()

Returns the ID of this DNS message.

setId

DnsMessage setId(int id)

Sets the ID of this DNS message.

opCode

DnsOpCode opCode()

Returns the opCode of this DNS message.

setOpCode

DnsMessage setOpCode(DnsOpCode opCode)

Sets the opCode of this DNS message.

isRecursionDesired

boolean isRecursionDesired()

Returns the RD (recursion desired} field of this DNS message.

setRecursionDesired

DnsMessage setRecursionDesired(boolean recursionDesired)

Sets the RD (recursion desired} field of this DNS message.

z

int z()

Returns the Z (reserved for future use) field of this DNS message.

setZ

DnsMessage setZ(int z)

Sets the Z (reserved for future use) field of this DNS message.

count

int count(DnsSection section)

Returns the number of records in the specified section of this DNS message.

count

int count()

Returns the number of records in this DNS message.

recordAt

<T extends DnsRecord> T recordAt(DnsSection section)

Returns the first record in the specified section of this DNS message. When the specified section is DnsSection.QUESTION, the type of the returned record is always DnsQuestion.

Returns:

null if this message doesn't have any records in the specified section

recordAt

<T extends DnsRecord> T recordAt(DnsSection section,
                                 int index)

Returns the record at the specified index of the specified section of this DNS message. When the specified section is DnsSection.QUESTION, the type of the returned record is always DnsQuestion.

Throws:

IndexOutOfBoundsException - if the specified index is out of bounds

setRecord

DnsMessage setRecord(DnsSection section,
                     DnsRecord record)

Sets the specified section of this DNS message to the specified record, making it a single-record section. When the specified section is DnsSection.QUESTION, the specified record must be a DnsQuestion.

setRecord

<T extends DnsRecord> T setRecord(DnsSection section,
                                  int index,
                                  DnsRecord record)

Sets the specified record at the specified index of the specified section of this DNS message. When the specified section is DnsSection.QUESTION, the specified record must be a DnsQuestion.

Returns:

the old record

Throws:

IndexOutOfBoundsException - if the specified index is out of bounds

addRecord

DnsMessage addRecord(DnsSection section,
                     DnsRecord record)

Adds the specified record at the end of the specified section of this DNS message. When the specified section is DnsSection.QUESTION, the specified record must be a DnsQuestion.

addRecord

DnsMessage addRecord(DnsSection section,
                     int index,
                     DnsRecord record)

Adds the specified record at the specified index of the specified section of this DNS message. When the specified section is DnsSection.QUESTION, the specified record must be a DnsQuestion.

Throws:

IndexOutOfBoundsException - if the specified index is out of bounds

removeRecord

<T extends DnsRecord> T removeRecord(DnsSection section,
                                     int index)

Removes the record at the specified index of the specified section from this DNS message. When the specified section is DnsSection.QUESTION, the type of the returned record is always DnsQuestion.

Returns:

the removed record

clear

DnsMessage clear(DnsSection section)

Removes all the records in the specified section of this DNS message.

clear

DnsMessage clear()

Removes all the records in this DNS message.

retain

DnsMessage retain()

Specified by:

retain in interface io.netty.util.ReferenceCounted

retain

DnsMessage retain(int increment)

Specified by:

retain in interface io.netty.util.ReferenceCounted