EPCDNS::ColocatedCandidate Class Reference

Represents a colocated candidate. More...

#include <epcdns.h>

Public Types
enum	PairType { ptUnknown = 0, ptColocated = 1, ptTopologicalDistance = 2, ptDNSPriority = 3 }
	Pair type. More...

Public Member Functions
	ColocatedCandidate (NodeSelectorResult &candidate1, NodeSelectorResult &candidate2)
	Class constructor. More...
NodeSelectorResult &	getCandidate1 ()
	Retrieves the first candidate node selector result object. More...
NodeSelectorResult &	getCandidate2 ()
	Retrieves the second candidate node selector result object. More...
CanonicalNodeName &	getCanonicalNodeName1 ()
	Retrieves the first canonical node name. More...
CanonicalNodeName &	getCanonicalNodeName2 ()
	Retrieves the second canonical node name. More...
PairType	getPairType ()
	Retrieves the pair type. More...
int	getTopologicalMatches ()
	Retrieves the number of topological matches. More...
Void	dump (const char *prefix)
	Prints the contents of this object. More...

Detailed Description

Represents a colocated candidate.

Member Enumeration Documentation

PairType

enum EPCDNS::ColocatedCandidate::PairType

Pair type.

Enumerator
ptUnknown	unknown
ptColocated	colocated
ptTopologicalDistance	topological distance
ptDNSPriority	DNS priority.

Constructor & Destructor Documentation

ColocatedCandidate()

ColocatedCandidate::ColocatedCandidate	(	NodeSelectorResult &	candidate1,
		NodeSelectorResult &	candidate2
	)

Class constructor.

Parameters

candidate1	the first candidate.
candidate2	the second candidate.

Member Function Documentation

dump()

Void EPCDNS::ColocatedCandidate::dump ( const char *  prefix )

inline

Prints the contents of this object.

Parameters

prefix

a value to prepend to each line.

getCandidate1()

NodeSelectorResult& EPCDNS::ColocatedCandidate::getCandidate1 ( )

inline

Retrieves the first candidate node selector result object.

Returns

the first candidate node selector result object.

getCandidate2()

NodeSelectorResult& EPCDNS::ColocatedCandidate::getCandidate2 ( )

inline

Retrieves the second candidate node selector result object.

Returns

the second candidate node selector result object.

getCanonicalNodeName1()

CanonicalNodeName& EPCDNS::ColocatedCandidate::getCanonicalNodeName1 ( )

inline

Retrieves the first canonical node name.

Returns

the first canonical node name.

getCanonicalNodeName2()

CanonicalNodeName& EPCDNS::ColocatedCandidate::getCanonicalNodeName2 ( )

inline

Retrieves the second canonical node name.

Returns

the second canonical node name.

getPairType()

PairType EPCDNS::ColocatedCandidate::getPairType ( )

inline

Retrieves the pair type.

Returns

the pair type.

getTopologicalMatches()

int EPCDNS::ColocatedCandidate::getTopologicalMatches ( )

inline

Retrieves the number of topological matches.

Returns

the number of topological matches.

---

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

• /home/vagrant/share/code/epctools/include/epc/epcdns.h
• /home/vagrant/share/code/epctools/src/epcdns.cpp