org.rvpf.base.som

Interface ReceiverSession

All Superinterfaces:

Remote, Session, SOMSession

All Known Implementing Classes:

QueueProxy.Receiver, ReceiverSessionImpl

public interface ReceiverSession
extends SOMSession

Receiver.

Nested Class Summary

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Method Summary

Modifier and Type	Method and Description
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 interface SOMSession

close

Methods inherited from interface Session

getConnectionMode, login, logout

Method Detail

commit

void commit()
     throws RemoteException,
            SessionException

Commits uncommitted messages.

Throws:

RemoteException - From RMI RunTime.

SessionException - From session security check.

purge

@Nonnegative
long purge()
                  throws RemoteException,
                         SessionException

Purges the queue.

Returns:

The number of messages purged.

Throws:

RemoteException - From RMI RunTime.

SessionException - From session security check.

receive

@Nonnull
 @CheckReturnValue
Serializable[] receive(@Nonnegative
                                                     int limit,
                                                     long timeout)
                                              throws RemoteException,
                                                     SessionException

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:

RemoteException - From RMI RunTime.

SessionException - From session security check.

rollback

void rollback()
       throws RemoteException,
              SessionException

Rolls back uncommitted messages.

Throws:

RemoteException - From RMI RunTime.

SessionException - From session security check.