com.pcbsys.nirvana.client.nConnectionQueueListener Interface Reference

This interface should be implemented by classes wishing to register to receive asynchronous notifications from the internal connection queue. More...

Public Member Functions
void	queueUnBlocked (long waitTime, int queueSize, long eventsTx, long eventsRx)
	This method is called by the nirvana API to notify a registered connection queue listener that the connection queue was blocked due to reaching it's high water mark for a period longer than that defined by the QueueBlockLimit but is now unblocked. More...
void	reachedAccessWaitLimit (long waitTime, int queueSize, long eventsTx, long eventsRx)
	This method is called by the nirvana API to notify a registered connection queue listener that the connection queue was unable to access the queue for a period longer than that defined by the QueueAccessWaitLimit. More...
void	reachedHWM (long hwm, int queueSize)
	This method is called by the nirvana API to notify a registered connection queue listener that the connection has hit it's high water mark. More...
void	reachedLWM (long lwm, int queueSize)
	This method is called by the nirvana API to notify a registered connection queue listener that the connection has hit it's low water mark. More...
void	reachedPushWaitLimit (long waitTime, int queueSize, long eventsTx, long eventsRx)
	This method is called by the nirvana API to notify a registered connection queue listener that the connection queue was unable to push an event to the queue for a period longer than that defined by the QueuePushWaitLimit. More...
void	reachedQueueBlockLimit (long waitTime, int queueSize, long eventsTx, long eventsRx)
	This method is called by the nirvana API to notify a registered connection queue listener that the connection queue was blocked due to reaching it's high water mark for a period longer than that defined by the QueueBlockLimit. More...

Detailed Description

This interface should be implemented by classes wishing to register to receive asynchronous notifications from the internal connection queue.

Such notifications include:

Reaching high water mark
Reaching low water mark
Exceeding the time it should take to access the queue object
Exceeding the time it should take to push an event onto the queue
Exceeding the time for a queue to be blocked due to reaching its high water mark


These limits are configurable under the ClientTimeouts section of the realm manager application

Member Function Documentation

void com.pcbsys.nirvana.client.nConnectionQueueListener.queueUnBlocked	(	long	waitTime,
		int	queueSize,
		long	eventsTx,
		long	eventsRx
	)

This method is called by the nirvana API to notify a registered connection queue listener that the connection queue was blocked due to reaching it's high water mark for a period longer than that defined by the QueueBlockLimit but is now unblocked.

Parameters

waitTime	the amount of time it took before the queue was unblocked
queueSize	the current queue size
eventsTx	the amount of events pushed by the connection
eventsRx	the amount of events received by the connection

void com.pcbsys.nirvana.client.nConnectionQueueListener.reachedAccessWaitLimit	(	long	waitTime,
		int	queueSize,
		long	eventsTx,
		long	eventsRx
	)

This method is called by the nirvana API to notify a registered connection queue listener that the connection queue was unable to access the queue for a period longer than that defined by the QueueAccessWaitLimit.

Parameters

waitTime	the amount of time it took to gain access to the queue
queueSize	the current queue size
eventsTx	the amount of events pushed by the connection
eventsRx	the amount of events received by the connection

void com.pcbsys.nirvana.client.nConnectionQueueListener.reachedHWM	(	long	hwm,
		int	queueSize
	)

This method is called by the nirvana API to notify a registered connection queue listener that the connection has hit it's high water mark.

Parameters

hwm	the current high water mark setting
queueSize	the current queue size

void com.pcbsys.nirvana.client.nConnectionQueueListener.reachedLWM	(	long	lwm,
		int	queueSize
	)

This method is called by the nirvana API to notify a registered connection queue listener that the connection has hit it's low water mark.

Parameters

lwm	the current low water mark setting
queueSize	the current queue size

void com.pcbsys.nirvana.client.nConnectionQueueListener.reachedPushWaitLimit	(	long	waitTime,
		int	queueSize,
		long	eventsTx,
		long	eventsRx
	)

This method is called by the nirvana API to notify a registered connection queue listener that the connection queue was unable to push an event to the queue for a period longer than that defined by the QueuePushWaitLimit.

Parameters

waitTime	the amount of time it took to push the event to the queue
queueSize	the current queue size
eventsTx	the amount of events pushed by the connection
eventsRx	the amount of events received by the connection

void com.pcbsys.nirvana.client.nConnectionQueueListener.reachedQueueBlockLimit	(	long	waitTime,
		int	queueSize,
		long	eventsTx,
		long	eventsRx
	)

This method is called by the nirvana API to notify a registered connection queue listener that the connection queue was blocked due to reaching it's high water mark for a period longer than that defined by the QueueBlockLimit.

Parameters

waitTime	the amount of time it took before the queue reached it's low water mark
queueSize	the current queue size
eventsTx	the amount of events pushed by the connection
eventsRx	the amount of events received by the connection