kanzi::connect::p2p::RoutingRules::Route Class Reference

Defines a route for a single communications element. More...

#include <routingrules.hpp>

Public Types
typedef unordered_map< string, string >::iterator	AttributeIterator
enum	RouteDef { Server = (1 << 0) , Direct = (1 << 1) }

Public Member Functions
AttributeIterator	beginAttributes ()
	Return beginning of attributes.
bool	directRouteEnabled () const
	Is direct route enabled.
bool	directRoutePossible () const
	Determines whether route is direct and it is possible.
AttributeIterator	endAttributes ()
	Return end of attributes iterator.
bool	equals (const RoutingRules::Route &other) const
	Compares routes.
const unordered_map< string, string > &	getAttributes () const
	Retrieve attribute references.
const string &	getBearer () const
	Retrieve bearer information.
shared_ptr< Endpoint >	getEndpoint () const
	Getter for endpoint.
const string &	getLink () const
	Getter for link information.
bool	getReliable () const
RouteDef	getRoute () const
	Getter for route.
const string &	getSubject () const
	Getter for subject information.
	Route (RouteDef r, string link)
	Constructor.
bool	serverRouteEnabled () const
	Routing via server enabled.
void	setAttributes (const unordered_map< string, string > &attributes)
	Stores the attributes specific for the route.
void	setBearer (string bearer)
	Stores bearer information.
void	setEndpoint (shared_ptr< Endpoint > &ep)
	Setter for endpoint.
void	setLink (const string &link)
	Setter for link.
void	setReliable (bool reliable)
void	setRoute (RouteDef route)
	Setter for route information.
void	setSubject (const string &subject)
	Setter for subject information.

Detailed Description

Defines a route for a single communications element.

Member Typedef Documentation

AttributeIterator

typedef unordered_map<string,string>::iterator kanzi::connect::p2p::RoutingRules::Route::AttributeIterator

Member Enumeration Documentation

RouteDef

enum kanzi::connect::p2p::RoutingRules::Route::RouteDef

Enumerator
Server	Route via Server.
Direct	Route directly.

Constructor & Destructor Documentation

Route()

kanzi::connect::p2p::RoutingRules::Route::Route ( RouteDef r, string link )

inline

Constructor.

Parameters

r	route
link	link

Member Function Documentation

beginAttributes()

AttributeIterator kanzi::connect::p2p::RoutingRules::Route::beginAttributes ( )

inline

Return beginning of attributes.

Returns

iterator to beginning of attributes

directRouteEnabled()

bool kanzi::connect::p2p::RoutingRules::Route::directRouteEnabled ( ) const

inline

Is direct route enabled.

Returns

true if direct route enabled

directRoutePossible()

bool kanzi::connect::p2p::RoutingRules::Route::directRoutePossible ( ) const

inline

Determines whether route is direct and it is possible.

Returns

true if direct route is possible

endAttributes()

AttributeIterator kanzi::connect::p2p::RoutingRules::Route::endAttributes ( )

inline

Return end of attributes iterator.

Returns

iterator to end of attributes

equals()

bool kanzi::connect::p2p::RoutingRules::Route::equals ( const RoutingRules::Route & other ) const

inline

Compares routes.

Parameters

other

the other route to compare this object to

Returns

true if routes equal.

getAttributes()

const unordered_map< string, string > & kanzi::connect::p2p::RoutingRules::Route::getAttributes ( ) const

inline

Retrieve attribute references.

Returns

reference to attribute container

getBearer()

const string & kanzi::connect::p2p::RoutingRules::Route::getBearer ( ) const

inline

Retrieve bearer information.

Returns

bearer

getEndpoint()

shared_ptr< Endpoint > kanzi::connect::p2p::RoutingRules::Route::getEndpoint ( ) const

inline

Getter for endpoint.

Returns

endpoint information

getLink()

const string & kanzi::connect::p2p::RoutingRules::Route::getLink ( ) const

inline

Getter for link information.

Returns

link information

getReliable()

bool kanzi::connect::p2p::RoutingRules::Route::getReliable ( ) const

inline

getRoute()

RouteDef kanzi::connect::p2p::RoutingRules::Route::getRoute ( ) const

inline

Getter for route.

Returns

route information

getSubject()

const string & kanzi::connect::p2p::RoutingRules::Route::getSubject ( ) const

inline

Getter for subject information.

Returns

subject information

serverRouteEnabled()

bool kanzi::connect::p2p::RoutingRules::Route::serverRouteEnabled ( ) const

inline

Routing via server enabled.

Returns

true if route via server enabled.

setAttributes()

void kanzi::connect::p2p::RoutingRules::Route::setAttributes ( const unordered_map< string, string > & attributes )

inline

Stores the attributes specific for the route.

Parameters

attributes

the attributes

setBearer()

void kanzi::connect::p2p::RoutingRules::Route::setBearer ( string bearer )

inline

Stores bearer information.

Parameters

bearer

the bearer information

setEndpoint()

void kanzi::connect::p2p::RoutingRules::Route::setEndpoint ( shared_ptr< Endpoint > & ep )

inline

Setter for endpoint.

Parameters

ep	endpoint to store

setLink()

void kanzi::connect::p2p::RoutingRules::Route::setLink ( const string & link )

inline

Setter for link.

Parameters

link	link informaiton

setReliable()

void kanzi::connect::p2p::RoutingRules::Route::setReliable ( bool reliable )

inline

setRoute()

void kanzi::connect::p2p::RoutingRules::Route::setRoute ( RouteDef route )

inline

Setter for route information.

Parameters

route

route

setSubject()

void kanzi::connect::p2p::RoutingRules::Route::setSubject ( const string & subject )

inline

Setter for subject information.

Parameters

subject

subject information

---

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

• connect/p2p/routingrules.hpp