- com
- pcbsys
- nirvana
- client
- nJoinInformation
This class is a container for all the information that defines a channel join. More...
Public Member Functions | |
boolean | allowPurgeRequests () |
Returns a boolean 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... | |
boolean | isArchival () |
Returns true if this join is an archival join. More... | |
boolean | isSource () |
Is this the source for the join or are events sent to this channel. More... | |
nJoinInformation (String channelName, int hopCount, String selector, boolean source, long lastEID, boolean allowPurge, boolean 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, | ||
boolean | source, | ||
long | lastEID, | ||
boolean | allowPurge, | ||
boolean | 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 |
boolean com.pcbsys.nirvana.client.nJoinInformation.allowPurgeRequests | ( | ) |
Returns a boolean 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.
boolean com.pcbsys.nirvana.client.nJoinInformation.isArchival | ( | ) |
Returns true if this join is an archival join.
boolean com.pcbsys.nirvana.client.nJoinInformation.isSource | ( | ) |
Is this the source for the join or are events sent to this channel.