com.pcbsys.nirvana.client.nQueueSyncReader Class Reference

This class provides the client with an synchronous interface into a Nirvana Queue. More...

Inheritance diagram for com.pcbsys.nirvana.client.nQueueSyncReader:

Public Member Functions
final nConsumeEvent	pop (final long timeout, final String selector) throws nSessionNotConnectedException, nSessionPausedException, nSecurityException, nIllegalStateException
	This method places thie client on the queue and will block until an event is placed onto the queue or the specified timeout expires.
final nConsumeEvent	pop (final long timeout) throws nSessionNotConnectedException,nSessionPausedException, nSecurityException, nIllegalStateException
	This method places thie client on the queue and will block until an event is placed onto the queue or the specified timeout expires.
final nConsumeEvent	pop () throws nSessionNotConnectedException, nSessionPausedException, nSecurityException, nIllegalStateException
	This method places thie client on the queue and will block until an event is placed onto the queue.

---

Detailed Description

This class provides the client with an synchronous interface into a Nirvana Queue.

Events will only be delivered to this client when a call to pop is made.

---

Member Function Documentation

final nConsumeEvent com.pcbsys.nirvana.client.nQueueSyncReader.pop	(	final long	timeout,
		final String	selector
	)			throws nSessionNotConnectedException, nSessionPausedException, nSecurityException, nIllegalStateException

This method places thie client on the queue and will block until an event is placed onto the queue or the specified timeout expires.

If the timeout expires it will return null

Parameters:

	timeout	Time to wait in milliseconds for an event
	selector	the selection string used to filter events being popped

Returns:

The popped event or null if the timeout expired

Exceptions:

	nSessionNotConnectedException	Client is not currently connected to the server
	nSecurityException	If your not authorized to perform the operation on the queue
	nSessionPausedException	The session is currently paused
	nIllegalStateException	The operation could not complete because of a session/connection error

final nConsumeEvent com.pcbsys.nirvana.client.nQueueSyncReader.pop

(

final long

timeout

)

throws nSessionNotConnectedException,nSessionPausedException, nSecurityException, nIllegalStateException

This method places thie client on the queue and will block until an event is placed onto the queue or the specified timeout expires.

If the timeout expires it will return null

Parameters:

timeout

Time to wait in milliseconds for an event

Returns:

The popped event or null if the timeout expired

Exceptions:

	nSessionNotConnectedException	Client is not currently connected to the server
	nSecurityException	If your not authorized to perform the operation on the queue
	nSessionPausedException	The session is currently paused
	nIllegalStateException	The operation could not complete because of a session/connection error

final nConsumeEvent com.pcbsys.nirvana.client.nQueueSyncReader.pop

(

)

throws nSessionNotConnectedException, nSessionPausedException, nSecurityException, nIllegalStateException

This method places thie client on the queue and will block until an event is placed onto the queue.

Returns:

The popped event

Exceptions:

	nSessionNotConnectedException	Client is not currently connected to the server
	nSecurityException	If your not authorized to perform the operation on the queue
	nSessionPausedException	The session is currently paused
	nIllegalStateException	The operation could not complete because of a session/connection error