net.jini.event

Interface RemoteEventIterator

public interface RemoteEventIterator

RemoteEventIterator defines the interface through which a client can synchronously retrieve events associated with a given registration.

Since:

2.1

Author:

Sun Microsystems, Inc.

Method Summary

Modifier and Type	Method and Description
void	close() Ends all event processing being performed by this iterator and invalidates the iterator.
RemoteEvent	next(long timeout) Retrieves stored event notifications, if any.

Method Detail

next

RemoteEvent next(long timeout)
          throws RemoteException,
                 InvalidIteratorException

Retrieves stored event notifications, if any.

Parameters:

timeout - the maximum time, in milliseconds, the event mailbox service should wait for the receipt of an event notification associated with this iterator's registration.

Returns:

The RemoteEvent

Throws:

IllegalArgumentException - if the supplied timeout parameter is less than 0.

InvalidIteratorException - if called on an invalidated iterator.

RemoteException - if there is a communication failure between the client and the service.

close

void close()
    throws InvalidIteratorException

Ends all event processing being performed by this iterator and invalidates the iterator.

Throws:

InvalidIteratorException - if called on an invalidated iterator.