Kanzi Connect  1.1.10
Kanzi Connect C++ API
kanzi::connect::p2p::RoutingRules::Endpoint Class Reference

Endpoint for communication. More...

#include <routingrules.hpp>

Public Types

typedef RouteAttributes::iterator AttributeIterator
 

Public Member Functions

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

Detailed Description

Endpoint for communication.

Member Typedef Documentation

◆ 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
othe 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
oobject 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
oobject to compare to
Returns
true if equals by address

◆ getAttributes()

const RouteAttributes& 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 RouteAttributes attributes)
inline

Stores the attributes specific for the route.

Parameters
attributesthe attributes

◆ setBearer()

void kanzi::connect::p2p::RoutingRules::Endpoint::setBearer ( const string &  bearer)
inline

Setter for bearer information.

Parameters
bearerthe bearer to set

◆ setConnectIdentifier()

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

Sets the connection identifier.

Parameters
connectIdentifiersome 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
identifierthe 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
ipthe ip address

◆ setMessageDispatcher()

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

Attach message dispatcher.

Parameters
dspthe dispatcher to attach

◆ setPort() [1/2]

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

Setter for port information.

Parameters
portthe 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
portthe port information

◆ setReliable()

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

Setter for reliable flag.

Parameters
reliablestate of the endpoint

◆ setUnreliable()

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

Setter for unreliable flag.

Parameters
unreliableunreliability 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: