edu.ucdavis.rj

Class OpMethod

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

edu.ucdavis.rj.OpImpl

edu.ucdavis.rj.OpMethod

All Implemented Interfaces:

Op, OpRemote, java.io.Serializable, java.rmi.Remote

public abstract class OpMethod
extends OpImpl

An operation that's to be serviced via a method. (Aka Proc-Op.) Extend this class with one that contains actual code.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface edu.ucdavis.rj.OpRemote

OpRemote.Helper

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
OpMethod() Create a new instance of an operation that's to be serviced via a method.

Method Summary

Modifier and Type	Method and Description
boolean	canAppearInInni() Can this operation be serviced by an inni? Only an OpInni can.
abstract void	codeBlock(Invocation inv) Override this method with the actual code for the operation.
void	deliverPendingMessages() If operation's queue of pending invocations was locked due to equivalence class locking stuff (e.g., merging), then deliver pending messages.
edu.ucdavis.rj.OpInniIterator	elements() Get an iterator to iterate over pending invocations of this operation.
long	getFirstTime() Get the timestamp of the first (oldest) pending invocation of this operation.
edu.ucdavis.rj.InLock	getLock() Get the equivalence class lock for this operation.
boolean	isRemote(java.lang.String site) Is this operation on a remote VM or on the current VM? (Not allowed on an OpMethod.)
int	length() Returns the number of Invocations pending for this operation.
Invocation	P() A semaphore P (aka down) operation.
Invocation	receive() Get the first (oldest) pending invocation of this OpInni.

Methods inherited from class edu.ucdavis.rj.OpImpl

call, call, equals, getId, hashCode, isNoop, send, send, V

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

getRef, toString, toStub

Methods inherited from class java.lang.Object

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

Constructor Detail

OpMethod

public OpMethod()
         throws java.rmi.RemoteException

Create a new instance of an operation that's to be serviced via a method.

Throws:

java.rmi.RemoteException - if RMI fails.

Method Detail

codeBlock

public abstract void codeBlock(Invocation inv)

Override this method with the actual code for the operation.

Parameters:

inv - The invocation to service.

receive

public Invocation receive()

Description copied from interface: Op

Get the first (oldest) pending invocation of this OpInni. Wait if no invocation is pending. (Not allowed on an OpMethod.)

Returns:

The first pending invocation.

getFirstTime

public long getFirstTime()

Description copied from interface: Op

Get the timestamp of the first (oldest) pending invocation of this operation.

Returns:

that timestamp.

canAppearInInni

public boolean canAppearInInni()
                        throws java.rmi.RemoteException

Description copied from interface: Op

Can this operation be serviced by an inni? Only an OpInni can.

Returns:

true if and only if this operation is an OpInni.

Throws:

java.rmi.RemoteException - if RMI fails.

getLock

public edu.ucdavis.rj.InLock getLock()
                              throws java.rmi.RemoteException

Description copied from interface: Op

Get the equivalence class lock for this operation. (Not allowed on an OpMethod.)

Returns:

that lock.

Throws:

java.rmi.RemoteException - if RMI fails.

isRemote

public boolean isRemote(java.lang.String site)
                 throws java.rmi.RemoteException

Description copied from interface: Op

Is this operation on a remote VM or on the current VM? (Not allowed on an OpMethod.)

Parameters:

site - machine name.

Returns:

true if and only if this operation is remote.

Throws:

java.rmi.RemoteException - if RMI fails.

deliverPendingMessages

public void deliverPendingMessages()
                            throws java.rmi.RemoteException

Description copied from interface: Op

If operation's queue of pending invocations was locked due to equivalence class locking stuff (e.g., merging), then deliver pending messages.

Throws:

java.rmi.RemoteException - if this Op is an OpMethod.

elements

public edu.ucdavis.rj.OpInniIterator elements()
                                       throws java.rmi.RemoteException

Description copied from interface: Op

Get an iterator to iterate over pending invocations of this operation.

Returns:

that iterator.

Throws:

java.rmi.RemoteException - if this Op is an OpMethod.

P

public Invocation P()

Description copied from interface: Op

A semaphore P (aka down) operation. Intended for use on OpInni's semaphore operations. (Not allowed on an OpMethod.)

Returns:

The first pending invocation.

length

public int length()

Returns the number of Invocations pending for this operation.

Specified by:

length in interface Op

Specified by:

length in class OpImpl

Returns:

The number of pending Invocations, which will be 0 for an OpMethod.