Package ucb.util.mailbox

Class Rendezvous<Msg extends java.io.Serializable>

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

ucb.util.mailbox.Rendezvous<Msg>

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, Mailbox<Msg>

public class Rendezvous<Msg extends java.io.Serializable>
extends java.rmi.server.UnicastRemoteObject

A Mailbox with a capacity of 0. A depositer must wait until his message is received.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Msg	msg
protected boolean	open

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Rendezvous(java.lang.Class<Msg> msgClass)

Method Summary

Modifier and Type	Method	Description
void	awaitClose()	Wait for THIS to be closed.
boolean	awaitClose(long millis)	Wait for THIS to be closed, or MILLIS milliseconds, whichever comes first.
int	capacity()	The capacity (see interface comment above) of THIS.
<T extends java.io.Serializable> Mailbox<T>	checkType(java.lang.Class<T> msgClass)	Returns THIS, assuming that THIS conveys messages of class MSGCLASS.
void	close()	Short for close (0).
void	close(long millis)	Performs a flush(MILLIS) and then invalidates THIS for all future use, deleting all remaining messages.
static <Msg extends java.io.Serializable> Rendezvous<Msg>	create()	A new Rendezvous for messages of unchecked type.
static <Msg extends java.io.Serializable> Rendezvous<Msg>	create(java.lang.Class<Msg> msgClass)	A new Rendezvous for messages of type MSGCLASS.
void	deposit(Msg msg)	Deposit MSG in this Mailbox.
boolean	deposit(Msg msg, long millis)	Deposit MSG in this Mailbox, if this can be done within approximately MILLIS milliseconds.
boolean	flush(long millis)	Wait for any queued message to be received, or MILLIS milliseconds, whichever comes first.
protected void	forward(Msg msg, long millis)
void	forwardTo(java.util.List<Mailbox<Msg>> boxes)	Forward copies of all messages (including any already present) to BOXES in the order received.
void	forwardTo(Mailbox<Msg> box)	Forward copies of all messages (including any already present) to BOXES in the order received.
boolean	isClosed()	True iff THIS is closed.
boolean	isForwarding()	True iff THIS is currently forwarding messages as a result of forwardTo.
java.lang.Class<Msg>	messageType()	The (runtime) type of message sent through this box.
protected long	myWait(long limit)
Msg	receive()	Receive the next queued message in this Mailbox.
Msg	receive(long millis)	Receive the next queued message in this Mailbox, if one is available within MILLIS milliseconds.
void	stopForwarding()	Stop forwarding copies of messages.

Methods inherited from class java.lang.Object

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

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, exportObject, exportObject, unexportObject

Field Detail

msg

protected Msg extends java.io.Serializable msg

open

protected boolean open

Constructor Detail

Rendezvous

protected Rendezvous(java.lang.Class<Msg> msgClass)
              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

create

public static <Msg extends java.io.Serializable> Rendezvous<Msg> create(java.lang.Class<Msg> msgClass)

A new Rendezvous for messages of type MSGCLASS.

create

public static <Msg extends java.io.Serializable> Rendezvous<Msg> create()

A new Rendezvous for messages of unchecked type.

deposit

public void deposit(Msg msg)
             throws java.lang.InterruptedException,
                    java.rmi.RemoteException

Deposit MSG in this Mailbox. If the Mailbox is full, wait if necessary for space to be available. MSG must be non-null. Throws Interrupted exception and does nothing if current thread is interrupted.

Throws:

java.lang.InterruptedException

java.rmi.RemoteException

deposit

public boolean deposit(Msg msg,
                       long millis)
                throws java.lang.InterruptedException,
                       java.rmi.RemoteException

Deposit MSG in this Mailbox, if this can be done within approximately MILLIS milliseconds. Returns true iff the message was deposited. Does not block if MILLIS is 0. MSG must be non-null. Throws Interrupted exception and does nothing if current thread is interrupted.

Throws:

java.lang.InterruptedException

java.rmi.RemoteException

receive

public Msg receive()
            throws java.lang.InterruptedException

Receive the next queued message in this Mailbox. Throws Interrupted exception and does nothing if current thread is interrupted.

Throws:

java.lang.InterruptedException

receive

public Msg receive(long millis)
            throws java.lang.InterruptedException

Receive the next queued message in this Mailbox, if one is available within MILLIS milliseconds. Returns null otherwise. Does not block if MILLIS is 0. Throws Interrupted exception and does nothing if current thread is interrupted.

Throws:

java.lang.InterruptedException

forwardTo

public void forwardTo(Mailbox<Msg> box)
               throws java.lang.InterruptedException,
                      java.rmi.RemoteException

Forward copies of all messages (including any already present) to BOXES in the order received. Once forwarded to all destinations, messages are otherwise treated as usual. Deposit blocks until all forwarding is complete.

Throws:

java.lang.InterruptedException

java.rmi.RemoteException

forwardTo

public void forwardTo(java.util.List<Mailbox<Msg>> boxes)
               throws java.lang.InterruptedException,
                      java.rmi.RemoteException

Description copied from interface: Mailbox

Forward copies of all messages (including any already present) to BOXES in the order received. Once forwarded to all destinations, messages are otherwise treated as usual. Deposit blocks until all forwarding is complete.

Throws:

java.lang.InterruptedException

java.rmi.RemoteException

stopForwarding

public void stopForwarding()

Stop forwarding copies of messages.

flush

public boolean flush(long millis)
              throws java.lang.InterruptedException

Wait for any queued message to be received, or MILLIS milliseconds, whichever comes first. Returns true if all pending messages were flushed within the time limit.

Throws:

java.lang.InterruptedException

close

public void close(long millis)
           throws java.lang.InterruptedException

Performs a flush(MILLIS) and then invalidates THIS for all future use, deleting all remaining messages. Any waiting threads or subsequent calls receive an immediate InvalidStateException indicating an invalid state. In general, the thread that uses a Mailbox to send messages is the one that closes it.

Throws:

java.lang.InterruptedException

close

public void close()
           throws java.lang.InterruptedException

Short for close (0).

Throws:

java.lang.InterruptedException

awaitClose

public void awaitClose()
                throws java.lang.InterruptedException

Wait for THIS to be closed. Receives and throws away any messages sent to THIS. Throws InterruptedException if current thread is interrupted first.

Throws:

java.lang.InterruptedException

awaitClose

public boolean awaitClose(long millis)
                   throws java.lang.InterruptedException

Wait for THIS to be closed, or MILLIS milliseconds, whichever comes first. Receives and throws away any messages sent to THIS. Returns true iff box is closed. Throws InterruptedException if current thread is interrupted first.

Throws:

java.lang.InterruptedException

isForwarding

public boolean isForwarding()

True iff THIS is currently forwarding messages as a result of forwardTo.

isClosed

public boolean isClosed()

Description copied from interface: Mailbox

True iff THIS is closed.

capacity

public int capacity()

The capacity (see interface comment above) of THIS.

forward

protected void forward(Msg msg,
                       long millis)
                throws java.rmi.RemoteException,
                       java.lang.InterruptedException

Throws:

java.rmi.RemoteException

java.lang.InterruptedException

myWait

protected long myWait(long limit)
               throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

messageType

public java.lang.Class<Msg> messageType()

Description copied from interface: Mailbox

The (runtime) type of message sent through this box.

Specified by:

messageType in interface Mailbox<Msg extends java.io.Serializable>

checkType

public <T extends java.io.Serializable> Mailbox<T> checkType(java.lang.Class<T> msgClass)

Description copied from interface: Mailbox

Returns THIS, assuming that THIS conveys messages of class MSGCLASS.

Specified by:

checkType in interface Mailbox<Msg extends java.io.Serializable>