com.pcbsys.nirvana.client.nJoinInformation Class Reference

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 propogated over the join link.
String	getDestination ()
	Returns the name of the channel destination channel is this channel is the source of the join otherwise returns null.
int	getHopCount ()
	The number of hops before the event is expired.
long	getLastEID ()
	The last Event ID processed by this join.
String	getSelector ()
	Returns the selector string.
String	getSource ()
	Returns the name of the source channel if the channel is not the source of the join otherwise returns null.
boolean	isArchival ()
	Returns true if this join is an archival join.
boolean	isSource ()
	Is this the source for the join or are events sent to this channel.
	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.

---

Detailed Description

This class is a container for all the information that defines a channel join.

---

Constructor & Destructor Documentation

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.

Parameters:

	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

---

Member Function Documentation

boolean com.pcbsys.nirvana.client.nJoinInformation.allowPurgeRequests

(

)

Returns a boolean indicating if purge requests are propogated over the join link.

Returns:

boolean flag

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.

Returns:

String channel name

int com.pcbsys.nirvana.client.nJoinInformation.getHopCount

(

)

The number of hops before the event is expired.

Returns:

int resend or hop count

long com.pcbsys.nirvana.client.nJoinInformation.getLastEID

(

)

The last Event ID processed by this join.

Returns:

long Event ID

String com.pcbsys.nirvana.client.nJoinInformation.getSelector

(

)

Returns the selector string.

Returns:

The message selector

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.

Returns:

String channel name

boolean com.pcbsys.nirvana.client.nJoinInformation.isArchival

(

)

Returns true if this join is an archival join.

Returns:

boolean is archival

boolean com.pcbsys.nirvana.client.nJoinInformation.isSource

(

)

Is this the source for the join or are events sent to this channel.

Returns:

boolean flag