This class contains information about a join between two channels. More...
Inherits com.pcbsys.nirvana.client.Observable.
Public Member Functions | |
| virtual bool | allowPurgeRequests () |
| Return whether purge requests are permitted in this join. More... | |
| virtual int | getHopCount () |
| Returns the number of times an event will be passed over a join. More... | |
| virtual long | getLastEID () |
| Returns the last Event ID sent to the remote join More... | |
| virtual nLeafNode | getRemoteNode () |
| Returns the nLeafNode of the remote end of the join, if this is a source join then this returns the destination else it returns the source. More... | |
| virtual string | getSelector () |
| Returns the selector used for the join. More... | |
| bool | isArchival () |
| Returns true if this join is an archival join More... | |
| virtual bool | isSource () |
| Returns a boolean flag representive of whether the channel is the source side of the join More... | |
| override string | ToString () |
| Returns a string representation of this object More... | |
This class contains information about a join between two channels.
There is a nJoinDetails for both sides of a join. On a channel which sends the events this is known as a source channel and this class will return true to isSource() function.
The source can also have a selector associacted with it while the channel receiving the events, the destination, has no selector associated with it.
|
virtual |
Return whether purge requests are permitted in this join.
When you purge an event from a channel, you can specify whether to purge from any subsequent joined channels, like a cascade deletion. If this flag is set to true, any purge requests from the source channel to the destination channel / queue will be enforced. If false, purge requests will not be enforced on the destination channel / queue.
|
virtual |
Returns the number of times an event will be passed over a join.
Useful if you wish to limit the number of time an event is sent over the network.
|
virtual |
Returns the last Event ID sent to the remote join
|
virtual |
|
virtual |
Returns the selector used for the join.
This is only applicable if the join is the source since the destination side of a join is not informed of the selector
| bool com.pcbsys.nirvana.nAdminAPI.nJoinDetails.isArchival | ( | ) |
Returns true if this join is an archival join
|
virtual |
Returns a boolean flag representive of whether the channel is the source side of the join
| override string com.pcbsys.nirvana.nAdminAPI.nJoinDetails.ToString | ( | ) |
Returns a string representation of this object
<return> string representation of object </return>