org.rvpf.som.queue

Class ReceiverWrapper

Object

SOMServerWrapper

QueueServerWrapper

ReceiverWrapper

public class ReceiverWrapper
extends QueueServerWrapper

Receiver wrapper.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the receiver.
void	commit() Commits uncommitted messages.
long	purge() Purges the queue.
Serializable[]	receive(int limit, long timeout) Receives messages.
void	rollback() Rolls back uncommitted messages.

Methods inherited from class QueueServerWrapper

getInfo, getQueueServer, getServer, isDirty

Methods inherited from class SOMServerWrapper

closeServer, getServerName, isServerClosed, tearDownServer, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

close

public void close()

Closes the receiver.

commit

public void commit()
            throws ServiceClosedException

Commits uncommitted messages.

Throws:

ServiceClosedException - When the service is closed.

purge

public long purge()
           throws ServiceClosedException

Purges the queue.

Returns:

The number of messages purged.

Throws:

ServiceClosedException - When the service is closed.

receive

@Nonnull
 @CheckReturnValue
public Serializable[] receive(int limit,
                                                            long timeout)
                                                     throws ServiceClosedException

Receives messages.

Parameters:

limit - The maximum number of messages.

timeout - A time limit in millis to wait for the first message (negative for infinite).

Returns:

The messages.

Throws:

ServiceClosedException - When the service is closed.

rollback

public void rollback()
              throws ServiceClosedException

Rolls back uncommitted messages.

Throws:

ServiceClosedException - When the service is closed.