This class is a container for all the information that defines a channel join. More...
Public Member Functions | |
| bool | allowPurgeRequests () |
| Returns a bool indicating if purge requests are propagated over the join link More... | |
| string | getDestination () |
| Returns the name of the channel destination channel is this channel is the source of the join otherwise returns null More... | |
| int | getHopCount () |
| The number of hops before the event is expired More... | |
| long | getLastEID () |
| The last Event ID processed by this join More... | |
| string | getSelector () |
| Returns the selector string More... | |
| string | getSource () |
| Returns the name of the source channel if the channel is not the source of the join otherwise returns null More... | |
| bool | isArchival () |
| Returns true if this join is an archival join More... | |
| bool | isSource () |
| Is this the source for the join or are events sent to this channel More... | |
| nJoinInformation (string channelName, int hopCount, string selector, bool source, long lastEID, bool allowPurge, bool archival) | |
| Constructs a nJoinInformation object containing all the required information to define a channel join. More... | |
This class is a container for all the information that defines a channel join.
| com.pcbsys.nirvana.client.nJoinInformation.nJoinInformation | ( | string | channelName, |
| int | hopCount, | ||
| string | selector, | ||
| bool | source, | ||
| long | lastEID, | ||
| bool | allowPurge, | ||
| bool | archival | ||
| ) |
Constructs a nJoinInformation object containing all the required information to define a channel join.
| channelName | The channel which this information relates to |
| hopCount | The number of hops before the event is expired |
| selector | The message select which controls which events are processed |
| source | If this channel is the source/destination |
| lastEID | The last EID processed for this join |
| allowPurge | Whether purges are propagated through this join |
| archival |
| bool com.pcbsys.nirvana.client.nJoinInformation.allowPurgeRequests | ( | ) |
Returns a bool indicating if purge requests are propagated over the join link
| string com.pcbsys.nirvana.client.nJoinInformation.getDestination | ( | ) |
Returns the name of the channel destination channel is this channel is the source of the join otherwise returns null
| int com.pcbsys.nirvana.client.nJoinInformation.getHopCount | ( | ) |
The number of hops before the event is expired
| long com.pcbsys.nirvana.client.nJoinInformation.getLastEID | ( | ) |
The last Event ID processed by this join
| string com.pcbsys.nirvana.client.nJoinInformation.getSelector | ( | ) |
Returns the selector string
| string com.pcbsys.nirvana.client.nJoinInformation.getSource | ( | ) |
Returns the name of the source channel if the channel is not the source of the join otherwise returns null
| bool com.pcbsys.nirvana.client.nJoinInformation.isArchival | ( | ) |
Returns true if this join is an archival join
| bool com.pcbsys.nirvana.client.nJoinInformation.isSource | ( | ) |
Is this the source for the join or are events sent to this channel