com.pcbsys.nirvana.nAdminAPI.nJoinable Interface Reference

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

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


Public Member Functions
void	join (nNode p_toNode, string p_selector)
	This method enables the joining of the object from one node to another, specifying a selector for filtered joins.
void	join (nNode p_toNode, bool p_isRouted, int p_hopcount, string p_Selector, bool allowPurge)
	This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events.
void	join (nNode p_toNode, bool p_isRouted, int p_hopcount, string p_Selector)
	This method enables the joining of the object from one node to another, specifying a selector, and a maximum hop count for the events.

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

void com.pcbsys.nirvana.nAdminAPI.nJoinable.join	(	nNode	p_toNode,
		string	p_selector
	)

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

Parameters:

	p_toNode	the nNode object to join this node to
	p_selector	a message selector specifying a filter for this message route

Exceptions:

	nUnsupportedJoinException	thrown if join is not supported (e.g. on queues)
	nBaseAdminException	is thrown if the join creation fails

void com.pcbsys.nirvana.nAdminAPI.nJoinable.join	(	nNode	p_toNode,
		bool	p_isRouted,
		int	p_hopcount,
		string	p_Selector,
		bool	allowPurge
	)

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:

	p_toNode	the nNode object to join this node to
	p_isRouted	Reserved for future use.
	p_hopcount	if 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
	p_Selector	a message selector specifying a filter for this message route
	allowPurge	specifies whether the join will permit purges to be propogated to all subsequent channels in the join path

Exceptions:

	nUnsupportedJoinException	thrown if join is not supported (e.g. on queues)
	nBaseAdminException	is thrown if the join creation fails

void com.pcbsys.nirvana.nAdminAPI.nJoinable.join	(	nNode	p_toNode,
		bool	p_isRouted,
		int	p_hopcount,
		string	p_Selector
	)

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:

	p_toNode	the nNode object to join this node to
	p_isRouted	Reserved for future use.
	p_hopcount	if 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
	p_Selector	a message selector specifying a filter for this message route

Exceptions:

	nUnsupportedJoinException	thrown if join is not supported (e.g. on queues)
	nBaseAdminException	is thrown if the join creation fails