Kea 2.5.7
isc::dns::RRsetCollectionBase::Iter Class Referenceabstract

A helper iterator interface for RRsetCollectionBase. More...

#include <rrset_collection_base.h>

+ Inheritance diagram for isc::dns::RRsetCollectionBase::Iter:

Public Member Functions

virtual ~Iter ()
 
virtual bool equals (Iter &other)=0
 Check if another iterator is equal to this one.
 
virtual IterPtr getNext ()=0
 Returns an IterPtr wrapping an Iter pointing to the next AbstractRRset in sequence in the collection.
 
virtual const isc::dns::AbstractRRsetgetValue ()=0
 Returns the AbstractRRset currently pointed to by the iterator.
 

Detailed Description

A helper iterator interface for RRsetCollectionBase.

This is a protected iterator class that is a helper interface used by the public iterator. Derived classes of RRsetCollectionBase are supposed to implement this class and the getBeginning() and getEnd() methods, so that the public iterator interface can be provided. This is a forward iterator only.

Definition at line 113 of file rrset_collection_base.h.

Constructor & Destructor Documentation

◆ ~Iter()

virtual isc::dns::RRsetCollectionBase::Iter::~Iter ( )
inlinevirtual

Definition at line 115 of file rrset_collection_base.h.

Member Function Documentation

◆ equals()

virtual bool isc::dns::RRsetCollectionBase::Iter::equals ( Iter other)
pure virtual

Check if another iterator is equal to this one.

Returns true if this iterator is equal to other, false otherwise. Note that if other is not the same type as this, or cannot be compared meaningfully, the method must return false.

Parameters
otherThe other iterator to compare against.
Returns
true if equal, false otherwise.

Implemented in isc::dns::RRsetCollection::DnsIter.

◆ getNext()

virtual IterPtr isc::dns::RRsetCollectionBase::Iter::getNext ( )
pure virtual

Returns an IterPtr wrapping an Iter pointing to the next AbstractRRset in sequence in the collection.

Implemented in isc::dns::RRsetCollection::DnsIter.

◆ getValue()

virtual const isc::dns::AbstractRRset & isc::dns::RRsetCollectionBase::Iter::getValue ( )
pure virtual

Returns the AbstractRRset currently pointed to by the iterator.

Implemented in isc::dns::RRsetCollection::DnsIter.


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