isc::dns::rdata::generic::SPF Class Reference

rdata::SPF class represents the SPF RDATA as defined in RFC4408. More...

#include <rdataclass.h>

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

Public Member Functions
	SPF (const std::string &type_str)
	SPF (isc::util::InputBuffer &buffer, size_t rdata_len)
	SPF (const SPF &other)
	SPF (MasterLexer &lexer, const Name *name, MasterLoader::Options options, MasterLoaderCallbacks &callbacks)
	~SPF ()
	The destructor. More...
virtual int	compare (const Rdata &other) const
	Compare two instances of Rdata. More...
const std::vector< std::vector< uint8_t > > &	getString () const
	Specialized methods. More...
SPF &	operator= (const SPF &source)
	Assignment operator. More...
virtual std::string	toText () const
	Convert an Rdata to a string. More...
virtual void	toWire (isc::util::OutputBuffer &buffer) const
	Render the Rdata in the wire format into a buffer. More...
virtual void	toWire (AbstractMessageRenderer &renderer) const
	Render the Rdata in the wire format into a MessageRenderer object. More...
Public Member Functions inherited from isc::dns::rdata::Rdata
virtual uint16_t	getLength () const
	Get the wire format length of an Rdata. More...
virtual	~Rdata ()
	The destructor. More...

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

Detailed Description

rdata::SPF class represents the SPF RDATA as defined in RFC4408.

This class implements the basic interfaces inherited from the abstract rdata::Rdata class. The semantics of the class is provided by a copy of instantiated TXTLikeImpl class common to both TXT and SPF.

Definition at line 1936 of file rdataclass.h.

Constructor & Destructor Documentation

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

explicit

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

isc::dns::rdata::generic::SPF::SPF

(

const SPF &

other

)

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

isc::dns::rdata::generic::SPF::~SPF

(

)

The destructor.

Member Function Documentation

virtual int isc::dns::rdata::generic::SPF::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.

const std::vector<std::vector<uint8_t> >& isc::dns::rdata::generic::SPF::getString

(

)

const

Specialized methods.

Return a reference to the data strings

This method never throws an exception.

SPF& isc::dns::rdata::generic::SPF::operator=

(

const SPF &

source

)

Assignment operator.

It internally allocates a resource, and if it fails a corresponding standard exception will be thrown. This operator never throws an exception otherwise.

This operator provides the strong exception guarantee: When an exception is thrown the content of the assignment target will be intact.

virtual std::string isc::dns::rdata::generic::SPF::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.

virtual void isc::dns::rdata::generic::SPF::toWire ( isc::util::OutputBuffer &  buffer ) 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

buffer

An output buffer to store the wire data.

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

virtual void isc::dns::rdata::generic::SPF::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.

---

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

• rdataclass.h