isc::dns::rdata::generic::SOA Class Reference

#include <rdataclass.h>

Inheritance diagram for isc::dns::rdata::generic::SOA:

Public Member Functions
	SOA (const Name &mname, const Name &rname, uint32_t serial, uint32_t refresh, uint32_t retry, uint32_t expire, uint32_t minimum)
	SOA (const SOA &other)
	SOA (const std::string &type_str)
	SOA (isc::util::InputBuffer &buffer, size_t rdata_len)
	SOA (MasterLexer &lexer, const Name *name, MasterLoader::Options options, MasterLoaderCallbacks &callbacks)
virtual int	compare (const Rdata &other) const
	Compare two instances of Rdata.
uint32_t	getMinimum () const
	brief Returns the minimum TTL field value of the SOA.
Serial	getSerial () const
	Returns the serial stored in the SOA.
virtual std::string	toText () const
	Convert an Rdata to a string.
virtual void	toWire (AbstractMessageRenderer &renderer) const
	Render the Rdata in the wire format into a MessageRenderer object.
virtual void	toWire (isc::util::OutputBuffer &buffer) const
	Render the Rdata in the wire format into a buffer.
Public Member Functions inherited from isc::dns::rdata::Rdata
virtual uint16_t	getLength () const
	Get the wire format length of an Rdata.
virtual	~Rdata ()
	The destructor.

Additional Inherited Members
Protected Member Functions inherited from isc::dns::rdata::Rdata
	Rdata ()
	The default constructor.

Detailed Description

Definition at line 370 of file rdataclass.h.

Constructor & Destructor Documentation

SOA() [1/5]

isc::dns::rdata::generic::SOA::SOA ( const std::string &  type_str )

explicit

SOA() [2/5]

isc::dns::rdata::generic::SOA::SOA	(	isc::util::InputBuffer &	buffer,
		size_t	rdata_len
	)

SOA() [3/5]

isc::dns::rdata::generic::SOA::SOA

(

const SOA &

other

)

SOA() [4/5]

isc::dns::rdata::generic::SOA::SOA	(	MasterLexer &	lexer,
		const Name *	name,
		MasterLoader::Options	options,
		MasterLoaderCallbacks &	callbacks
	)

SOA() [5/5]

isc::dns::rdata::generic::SOA::SOA	(	const Name &	mname,
		const Name &	rname,
		uint32_t	serial,
		uint32_t	refresh,
		uint32_t	retry,
		uint32_t	expire,
		uint32_t	minimum
	)

Member Function Documentation

compare()

virtual int isc::dns::rdata::generic::SOA::compare ( const Rdata &  other ) const

virtual

Compare two instances of Rdata.

This method compares this and the other Rdata objects in terms of the DNSSEC sorting order as defined in RFC4034, and returns the result as an integer.

This is a pure virtual method without the definition; the actual comparison logic is specific to each derived concrete class and should be explicitly defined in the derived class.

Specific implementations of this method must confirm that this and the other are objects of the same concrete derived class of Rdata. This is normally done by dynamic_cast in the implementation. It also means if the assumption isn't met an exception of class std::bad_cast will be thrown.

Here is an implementation choice: instead of relying on dynamic_cast, we could first convert the data into wire-format and compare the pair as opaque data. This would be more polymorphic, but might involve significant overhead, especially for a large size of RDATA.

Parameters

other

the right-hand operand to compare against.

Returns

< 0 if this would be sorted before other.

0 if this is identical to other in terms of sorting order.

> 0 if this would be sorted after other.

Implements isc::dns::rdata::Rdata.

getMinimum()

uint32_t isc::dns::rdata::generic::SOA::getMinimum

(

)

const

brief Returns the minimum TTL field value of the SOA.

getSerial()

Serial isc::dns::rdata::generic::SOA::getSerial

(

)

const

Returns the serial stored in the SOA.

toText()

virtual std::string isc::dns::rdata::generic::SOA::toText ( ) const

virtual

Convert an Rdata to a string.

This method returns a std::string object representing the Rdata.

This is a pure virtual method without the definition; the actual representation is specific to each derived concrete class and should be explicitly defined in the derived class.

Returns

A string representation of Rdata.

Implements isc::dns::rdata::Rdata.

toWire() [1/2]

virtual void isc::dns::rdata::generic::SOA::toWire ( AbstractMessageRenderer &  renderer ) const

virtual

Render the Rdata in the wire format into a MessageRenderer object.

This is a pure virtual method without the definition; the actual conversion is specific to each derived concrete class and should be explicitly defined in the derived class.

Parameters

renderer

DNS message rendering context that encapsulates the output buffer in which the Rdata is to be stored.

Implements isc::dns::rdata::Rdata.

toWire() [2/2]

virtual void isc::dns::rdata::generic::SOA::toWire ( isc::util::OutputBuffer &  buff ) const

virtual

Render the Rdata in the wire format into a buffer.

This is a pure virtual method without the definition; the actual conversion is specific to each derived concrete class and should be explicitly defined in the derived class.

Parameters

buff	An output buffer to store the wire data.

Implements isc::dns::rdata::Rdata.

---

The documentation for this class was generated from the following file:

• rdataclass.h