hydra.training

Interface RemoteBlockingQueue

All Superinterfaces:

Remote

All Known Implementing Classes:

RemoteBlockingQueueImpl

public interface RemoteBlockingQueue
extends Remote

A blocking queue that is shared among multiple Java programs potentially running on multiple machines. It is inspiried by the JSR-166 BlockingQueue and is implemented using standard Java RMI.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
boolean	offer(Object o) Inserts the specified element into this queue, if possible.
boolean	offer(Object o, long timeout, TimeUnit unit) Inserts the specified element into this queue, waiting if necessary up to the specified wait time for space to become available.
Object	peek() Retrieves, but does not remove, the head of this queue, returning null if this queue is empty.
Object	poll() Retrieves and removes the head of this queue.
Object	poll(long timeout, TimeUnit unit) Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time if no elements are present on this queue.
void	put(Object o) Adds the specified element to this queue, waiting if necessary for space to become available.
Object	take() Retrieves and removes the head of this queue, waiting if no elements are present on this queue.

Method Detail

offer

boolean offer(Object o)
       throws RemoteException

Inserts the specified element into this queue, if possible. When using queues that may impose insertion restrictions (for example capacity bounds), method offer is generally preferable to method Collection.add(E), which can fail to insert an element only by throwing an exception.

Parameters:

o - the element to add.

Returns:

true if it was possible to add the element to this queue, else false

Throws:

NullPointerException - if the specified element is null.

RemoteException

offer

boolean offer(Object o,
              long timeout,
              TimeUnit unit)
       throws InterruptedException,
              RemoteException

Inserts the specified element into this queue, waiting if necessary up to the specified wait time for space to become available.

Parameters:

o - the element to add

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

true if successful, or false if the specified waiting time elapses before space is available.

Throws:

InterruptedException - if interrupted while waiting.

NullPointerException - if the specified element is null.

RemoteException

poll

Object poll(long timeout,
            TimeUnit unit)
     throws InterruptedException,
            RemoteException

Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time if no elements are present on this queue.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is present.

Throws:

InterruptedException - if interrupted while waiting.

RemoteException

poll

Object poll()
     throws RemoteException

Retrieves and removes the head of this queue. This method differs from the poll method in that it throws an exception if this queue is empty.

Returns:

the head of this queue.

Throws:

NoSuchElementException - if this queue is empty.

RemoteException

take

Object take()
     throws InterruptedException,
            RemoteException

Retrieves and removes the head of this queue, waiting if no elements are present on this queue.

Returns:

the head of this queue

Throws:

InterruptedException - if interrupted while waiting.

RemoteException

put

void put(Object o)
  throws InterruptedException,
         RemoteException

Adds the specified element to this queue, waiting if necessary for space to become available.

Parameters:

o - the element to add

Throws:

InterruptedException - if interrupted while waiting.

NullPointerException - if the specified element is null.

RemoteException

peek

Object peek()
     throws RemoteException

Retrieves, but does not remove, the head of this queue, returning null if this queue is empty.

Returns:

the head of this queue, or null if this queue is empty.

Throws:

RemoteException