io.netty.handler.codec.dns

Class AbstractDnsMessage

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.codec.dns.AbstractDnsMessage

All Implemented Interfaces:

DnsMessage, ReferenceCounted

Direct Known Subclasses:

DefaultDnsQuery, DefaultDnsResponse

@UnstableApi
public abstract class AbstractDnsMessage
extends AbstractReferenceCounted
implements DnsMessage

A skeletal implementation of DnsMessage.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDnsMessage(int id) Creates a new instance with the specified id and DnsOpCode.QUERY opCode.
protected	AbstractDnsMessage(int id, DnsOpCode opCode) Creates a new instance with the specified id and opCode.

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.
protected void	deallocate() Called once AbstractReferenceCounted.refCnt() is equals 0.
boolean	equals(Object obj)
int	hashCode()
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() Increases the reference count by 1.
DnsMessage	retain(int increment) Increases the reference count by the specified 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.
DnsMessage	touch() Records the current access location of this object for debugging purposes.
DnsMessage	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.
int	z() Returns the Z (reserved for future use) field of this DNS message.

Methods inherited from class io.netty.util.AbstractReferenceCounted

refCnt, release, release, setRefCnt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Constructor Detail

AbstractDnsMessage

protected AbstractDnsMessage(int id)

Creates a new instance with the specified id and DnsOpCode.QUERY opCode.

AbstractDnsMessage

protected AbstractDnsMessage(int id,
                             DnsOpCode opCode)

Creates a new instance with the specified id and opCode.

Method Detail

id

public int id()

Description copied from interface: DnsMessage

Returns the ID of this DNS message.

Specified by:

id in interface DnsMessage

setId

public DnsMessage setId(int id)

Description copied from interface: DnsMessage

Sets the ID of this DNS message.

Specified by:

setId in interface DnsMessage

opCode

public DnsOpCode opCode()

Description copied from interface: DnsMessage

Returns the opCode of this DNS message.

Specified by:

opCode in interface DnsMessage

setOpCode

public DnsMessage setOpCode(DnsOpCode opCode)

Description copied from interface: DnsMessage

Sets the opCode of this DNS message.

Specified by:

setOpCode in interface DnsMessage

isRecursionDesired

public boolean isRecursionDesired()

Description copied from interface: DnsMessage

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

Specified by:

isRecursionDesired in interface DnsMessage

setRecursionDesired

public DnsMessage setRecursionDesired(boolean recursionDesired)

Description copied from interface: DnsMessage

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

Specified by:

setRecursionDesired in interface DnsMessage

z

public int z()

Description copied from interface: DnsMessage

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

Specified by:

z in interface DnsMessage

setZ

public DnsMessage setZ(int z)

Description copied from interface: DnsMessage

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

Specified by:

setZ in interface DnsMessage

count

public int count(DnsSection section)

Description copied from interface: DnsMessage

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

Specified by:

count in interface DnsMessage

count

public int count()

Description copied from interface: DnsMessage

Returns the number of records in this DNS message.

Specified by:

count in interface DnsMessage

recordAt

public <T extends DnsRecord> T recordAt(DnsSection section)

Description copied from interface: DnsMessage

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.

Specified by:

recordAt in interface DnsMessage

Returns:

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

recordAt

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

Description copied from interface: DnsMessage

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.

Specified by:

recordAt in interface DnsMessage

setRecord

public DnsMessage setRecord(DnsSection section,
                            DnsRecord record)

Description copied from interface: DnsMessage

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.

Specified by:

setRecord in interface DnsMessage

setRecord

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

Description copied from interface: DnsMessage

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.

Specified by:

setRecord in interface DnsMessage

Returns:

the old record

addRecord

public DnsMessage addRecord(DnsSection section,
                            DnsRecord record)

Description copied from interface: DnsMessage

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.

Specified by:

addRecord in interface DnsMessage

addRecord

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

Description copied from interface: DnsMessage

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.

Specified by:

addRecord in interface DnsMessage

removeRecord

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

Description copied from interface: DnsMessage

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.

Specified by:

removeRecord in interface DnsMessage

Returns:

the removed record

clear

public DnsMessage clear(DnsSection section)

Description copied from interface: DnsMessage

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

Specified by:

clear in interface DnsMessage

clear

public DnsMessage clear()

Description copied from interface: DnsMessage

Removes all the records in this DNS message.

Specified by:

clear in interface DnsMessage

touch

public DnsMessage touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface DnsMessage

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractReferenceCounted

touch

public DnsMessage touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface DnsMessage

Specified by:

touch in interface ReferenceCounted

retain

public DnsMessage retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface DnsMessage

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

retain

public DnsMessage retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface DnsMessage

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object