com::pcbsys::nirvana::nAdminAPI::nJoinable Class Referenceabstract

All classes that can be joined from one part of the namespace to another implement this interface. More...

#include <nJoinable.h>

Inheritance diagram for com::pcbsys::nirvana::nAdminAPI::nJoinable:
com::pcbsys::nirvana::nAdminAPI::nLeafNode

Public Member Functions

virtual void join (nNode *pToNode, bool bIsRouted, int hopcount, const std::string &selector)=0
 This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events. More...
 
virtual void join (nNode *pToNode, bool bIsRouted, int hopcount, const std::string &selector, bool allowPurge)=0
 This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events. More...
 
virtual void join (nNode *pToNode, const std::string &selector)=0
 This method enables the joining of the object from one node to another, specifying a selector for filtered joins. More...
 

Detailed Description

All classes that can be joined from one part of the namespace to another implement this interface.

This allows easy manipulation of the nirvana namespace objects that can be joined together i.e. channels

Member Function Documentation

virtual void com::pcbsys::nirvana::nAdminAPI::nJoinable::join ( nNode pToNode,
bool  bIsRouted,
int  hopcount,
const std::string &  selector 
)
pure virtual

This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events.

Parameters
*pToNodethe nNode object to join this node to
bIsRoutedReserved for future use.
hopcountif an event is published directly to this node (i.e. does not arrive here through another join), this is the maximum number of hops it will follow
selectora message selector specifying a filter for this message route
Exceptions
nUnsupportedJoinExceptionthrown if join is not supported (e.g. on queues)
nBaseAdminExceptionis thrown if the join creation fails
See Also
nLeafNode

Implemented in com::pcbsys::nirvana::nAdminAPI::nLeafNode.

virtual void com::pcbsys::nirvana::nAdminAPI::nJoinable::join ( nNode pToNode,
bool  bIsRouted,
int  hopcount,
const std::string &  selector,
bool  allowPurge 
)
pure virtual

This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events.

Parameters
*pToNodethe nNode object to join this node to
bIsRoutedReserved for future use.
hopcountif an event is published directly to this node (i.e. does not arrive here through another join), this is the maximum number of hops it will follow
selectora message selector specifying a filter for this message route
allowPurgespecifies whether the join will permit purges to be propagated to all subsequent channels in the join path
Exceptions
nUnsupportedJoinExceptionthrown if join is not supported (e.g. on queues)
nBaseAdminExceptionis thrown if the join creation fails
See Also
nLeafNode

Implemented in com::pcbsys::nirvana::nAdminAPI::nLeafNode.

virtual void com::pcbsys::nirvana::nAdminAPI::nJoinable::join ( nNode pToNode,
const std::string &  selector 
)
pure virtual

This method enables the joining of the object from one node to another, specifying a selector for filtered joins.

Parameters
*pToNodethe nNode object to join this node to
selectora message selector specifying a filter for this message route
Exceptions
nUnsupportedJoinExceptionthrown if join is not supported (e.g. on queues)
nBaseAdminExceptionis thrown if the join creation fails
See Also
nLeafNode

Implemented in com::pcbsys::nirvana::nAdminAPI::nLeafNode.