kanzi::connect::p2p::RoutingRules::Endpoint Class Reference

Endpoint for communication. More...

#include <routingrules.hpp>

Public Types
typedef unordered_map< string, string >::iterator	AttributeIterator

Public Member Functions
AttributeIterator	beginAttributes ()
	Return beginning of attributes.
AttributeIterator	endAttributes ()
	Return end of attributes iterator.
	Endpoint ()
	Constructor.
bool	equals (const Endpoint &o) const
	Compares this and passed object by all information.
bool	equalsByAddress (const Endpoint &o) const
	Compares this and passed object by address information.
bool	equalsByAddressAndReliability (const Endpoint &o) const
	Compares this and passed object by address and relialibility information.
const unordered_map< string, string > &	getAttributes () const
	Retrieve attribute references.
const string &	getBearer () const
	Getter for bearer information.
const string &	getConnectIdentifier () const
	Retrieve previously set connect identifier.
const string &	getIdentifier () const
	Retrieves then endpoint identifier.
const string &	getIP () const
	Getter for IP Address.
MessageDispatcher *	getMessageDispatcher () const
	Getter for message dispatcher.
const string &	getPort () const
	Getter for port information.
bool	getReliable () const
	Getter for reliable.
bool	getUnreliable () const
	Getter for unreliable flag.
void	setAttributes (const unordered_map< string, string > &attributes)
	Stores the attributes specific for the route.
void	setBearer (const string &bearer)
	Setter for bearer information.
void	setConnectIdentifier (const string &connectIdentifier)
	Sets the connection identifier.
void	setIdentifier (const string &identifier)
	sets the endpoint identifier
void	setIP (const string &ip)
	Setter for IP Address.
void	setMessageDispatcher (MessageDispatcher *dsp)
	Attach message dispatcher.
void	setPort (const string &port)
	Setter for port information.
void	setPort (int port)
	Setter for port information.
void	setReliable (bool reliable)
	Setter for reliable flag.
void	setUnreliable (bool unreliable=true)
	Setter for unreliable flag.
string	toString () const
	Get stringular representation of the endpoint.
bool	valid () const
	Checks is object valid.

Detailed Description

Endpoint for communication.

Member Typedef Documentation

AttributeIterator

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

Constructor & Destructor Documentation

Endpoint()

kanzi::connect::p2p::RoutingRules::Endpoint::Endpoint ( )

inline

Constructor.

Member Function Documentation

beginAttributes()

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

inline

Return beginning of attributes.

Returns

iterator to beginning of attributes

endAttributes()

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

inline

Return end of attributes iterator.

Returns

iterator to end of attributes

equals()

bool kanzi::connect::p2p::RoutingRules::Endpoint::equals ( const Endpoint & o ) const

inline

Compares this and passed object by all information.

Parameters

o	the object to compare to

Returns

true if equals

equalsByAddress()

bool kanzi::connect::p2p::RoutingRules::Endpoint::equalsByAddress ( const Endpoint & o ) const

inline

Compares this and passed object by address information.

Parameters

o	object to compare to

Returns

true if equals by address

equalsByAddressAndReliability()

bool kanzi::connect::p2p::RoutingRules::Endpoint::equalsByAddressAndReliability ( const Endpoint & o ) const

inline

Compares this and passed object by address and relialibility information.

Parameters

o	object to compare to

Returns

true if equals by address

getAttributes()

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

inline

Retrieve attribute references.

Returns

reference to attribute container

getBearer()

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

inline

Getter for bearer information.

Returns

the bearer information

getConnectIdentifier()

const string & kanzi::connect::p2p::RoutingRules::Endpoint::getConnectIdentifier ( ) const

inline

Retrieve previously set connect identifier.

Returns

connectIdentifier value.

getIdentifier()

const string & kanzi::connect::p2p::RoutingRules::Endpoint::getIdentifier ( ) const

inline

Retrieves then endpoint identifier.

Returns

endpoint identifier

getIP()

const string & kanzi::connect::p2p::RoutingRules::Endpoint::getIP ( ) const

inline

Getter for IP Address.

Returns

IP Address

getMessageDispatcher()

MessageDispatcher * kanzi::connect::p2p::RoutingRules::Endpoint::getMessageDispatcher ( ) const

inline

Getter for message dispatcher.

Returns

message dispatcher

getPort()

const string & kanzi::connect::p2p::RoutingRules::Endpoint::getPort ( ) const

inline

Getter for port information.

Returns

port number

getReliable()

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

inline

Getter for reliable.

Returns

true if reliable.

getUnreliable()

bool kanzi::connect::p2p::RoutingRules::Endpoint::getUnreliable ( ) const

inline

Getter for unreliable flag.

Returns

true if unreliable

setAttributes()

void kanzi::connect::p2p::RoutingRules::Endpoint::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::Endpoint::setBearer ( const string & bearer )

inline

Setter for bearer information.

Parameters

bearer

the bearer to set

setConnectIdentifier()

void kanzi::connect::p2p::RoutingRules::Endpoint::setConnectIdentifier ( const string & connectIdentifier )

inline

Sets the connection identifier.

Parameters

connectIdentifier

some identifier using which the client can reach this service with selected bearer.

setIdentifier()

void kanzi::connect::p2p::RoutingRules::Endpoint::setIdentifier ( const string & identifier )

inline

sets the endpoint identifier

Parameters

identifier

the name of the endpoint

setIP()

void kanzi::connect::p2p::RoutingRules::Endpoint::setIP ( const string & ip )

inline

Setter for IP Address.

For server side IP defines the interface to bind into.

Parameters

ip	the ip address

setMessageDispatcher()

void kanzi::connect::p2p::RoutingRules::Endpoint::setMessageDispatcher ( MessageDispatcher * dsp )

inline

Attach message dispatcher.

Parameters

dsp	the dispatcher to attach

setPort() [1/2]

void kanzi::connect::p2p::RoutingRules::Endpoint::setPort ( const string & port )

inline

Setter for port information.

Parameters

port	the port information to set in string format

setPort() [2/2]

void kanzi::connect::p2p::RoutingRules::Endpoint::setPort ( int port )

inline

Setter for port information.

Parameters

port	the port information

setReliable()

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

inline

Setter for reliable flag.

Parameters

reliable

state of the endpoint

setUnreliable()

void kanzi::connect::p2p::RoutingRules::Endpoint::setUnreliable ( bool unreliable = true )

inline

Setter for unreliable flag.

Parameters

unreliable

unreliability state of the endpoint

toString()

string kanzi::connect::p2p::RoutingRules::Endpoint::toString

(

)

const

Get stringular representation of the endpoint.

Returns

stringified representation of the object

valid()

bool kanzi::connect::p2p::RoutingRules::Endpoint::valid ( ) const

inline

Checks is object valid.

Returns

true if valid.

---

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

• connect/p2p/routingrules.hpp