hydra.training

Class RemoteBlockingQueueImpl

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

hydra.training.RemoteBlockingQueueImpl

All Implemented Interfaces:

RemoteBlockingQueue, Serializable, Remote

public class RemoteBlockingQueueImpl
extends UnicastRemoteObject
implements RemoteBlockingQueue

An implementation of RemoteBlockingQueue that uses a JSR-166 BlockingQueue to do the real work.

Since:

4.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
RemoteBlockingQueueImpl(int capacity) Creates a new RemoteBlockingQueueImpl with the given maximum number of elements.

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.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteBlockingQueueImpl

public RemoteBlockingQueueImpl(int capacity)
                        throws RemoteException

Creates a new RemoteBlockingQueueImpl with the given maximum number of elements.

Throws:

RemoteException

Method Detail

offer

public boolean offer(Object o)
              throws RemoteException

Description copied from interface: RemoteBlockingQueue

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.

Specified by:

offer in interface RemoteBlockingQueue

Parameters:

o - the element to add.

Returns:

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

Throws:

RemoteException

offer

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

Description copied from interface: RemoteBlockingQueue

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

Specified by:

offer in interface RemoteBlockingQueue

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.

RemoteException

poll

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

Description copied from interface: RemoteBlockingQueue

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.

Specified by:

poll in interface RemoteBlockingQueue

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

public Object poll()
            throws RemoteException

Description copied from interface: RemoteBlockingQueue

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.

Specified by:

poll in interface RemoteBlockingQueue

Returns:

the head of this queue.

Throws:

RemoteException

take

public Object take()
            throws InterruptedException,
                   RemoteException

Description copied from interface: RemoteBlockingQueue

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

Specified by:

take in interface RemoteBlockingQueue

Returns:

the head of this queue

Throws:

InterruptedException - if interrupted while waiting.

RemoteException

put

public void put(Object o)
         throws InterruptedException,
                RemoteException

Description copied from interface: RemoteBlockingQueue

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

Specified by:

put in interface RemoteBlockingQueue

Parameters:

o - the element to add

Throws:

InterruptedException - if interrupted while waiting.

RemoteException

peek

public Object peek()
            throws RemoteException

Description copied from interface: RemoteBlockingQueue

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

Specified by:

peek in interface RemoteBlockingQueue

Returns:

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

Throws:

RemoteException