com.pcbsys.nirvana.client.nQueueSyncFragmentReader Class Reference

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

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

com.pcbsys.nirvana.client.nQueueReader com.pcbsys.nirvana.client.nQueueSyncTransactionFragmentReader

Public Member Functions

final nConsumeEvent pop (final long timeout, final String selector) throws nSessionNotConnectedException, nSessionPausedException, nSecurityException, nIllegalStateException
 This method places this 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 this 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 this 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 and after all event fragments have been received.

Member Function Documentation

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

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

This reader behaves exactly like the nQueueSyncReader with the exception that it understands fragmented events and will only return an event when all fragments are received.

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:
com.pcbsys.nirvana.client.nSessionNotConnectedException Client is not currently connected to the server
com.pcbsys.nirvana.client.nSecurityException If your not authorized to perform the operation on the queue
com.pcbsys.nirvana.client.nSessionPausedException The session is currently paused
com.pcbsys.nirvana.client.nIllegalStateException The operation could not complete because of a session/connection error

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

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

This reader behaves exactly like the nQueueSyncReader with the exception that it understands fragmented events and will only return an event when all fragments are received.

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:
com.pcbsys.nirvana.client.nSessionNotConnectedException Client is not currently connected to the server
com.pcbsys.nirvana.client.nSecurityException If your not authorized to perform the operation on the queue
com.pcbsys.nirvana.client.nSessionPausedException The session is currently paused
com.pcbsys.nirvana.client.nIllegalStateException The operation could not complete because of a session/connection error

final nConsumeEvent com.pcbsys.nirvana.client.nQueueSyncFragmentReader.pop (  )  throws nSessionNotConnectedException, nSessionPausedException, nSecurityException, nIllegalStateException

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

This reader behaves exactly like the nQueueSyncReader with the exception that it understands fragmented events and will only return an event when all fragments are received.

Returns:
The popped event
Exceptions:
com.pcbsys.nirvana.client.nSessionNotConnectedException Client is not currently connected to the server
com.pcbsys.nirvana.client.nSecurityException If your not authorized to perform the operation on the queue
com.pcbsys.nirvana.client.nSessionPausedException The session is currently paused
com.pcbsys.nirvana.client.nIllegalStateException The operation could not complete because of a session/connection error