provided.compute

Interface ICompute

All Superinterfaces:

java.rmi.Remote

public interface ICompute
extends java.rmi.Remote

A generalized compute engine object that will execute a given ITask object and return the result. A compute engine IS an RMI Server object and is itself, NOT transmitted to anyone. ONLY the STUB of this Remote object is ever transmitted. This interface ONLY defines the methods needed by a REMOTE system!

Note that an implementation of this interface may include additional methods to enable the compute engine to interact with the local system as well as adapter(s) as needed to communicate with the LOCAL system's model and/or view.

Any ICompute implementation MUST be able to:
- Display the ITask computation's results on the Engine system's user interface
- Enable the Engine system to be able to send a text message to the client's user interface.

IMPORTANT: The engine model is NOT the same as the compute engine!! The compute engine (this interface) is just one of the objects managed by the engine model.

Author:

Stephen Wong

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BOUND_NAME The name the ICompute object will be bound to in the RMI Registry
static int	BOUND_PORT The port that the client will use to communicate with the ICompute object Note that this port must be opened of inbound traffic on the server machine

Method Summary

Modifier and Type	Method and Description
<T> T	executeTask(ITask<T> t) Execute the given ITask object and return the result
IRemoteTaskViewAdapter	setTextAdapter(IRemoteTaskViewAdapter clientTVAStub) Sets this object's IRemoteTaskViewAdapter stub so that it can print strings out on the client's user interface.

Field Detail

BOUND_NAME

static final java.lang.String BOUND_NAME

The name the ICompute object will be bound to in the RMI Registry

See Also:

Constant Field Values

BOUND_PORT

static final int BOUND_PORT

The port that the client will use to communicate with the ICompute object Note that this port must be opened of inbound traffic on the server machine

See Also:

Constant Field Values

Method Detail

executeTask

<T> T executeTask(ITask<T> t)
           throws java.rmi.RemoteException

Execute the given ITask object and return the result

Type Parameters:

T - The type of the return value from executing the given ITask object

Parameters:

t - The ITask object to execute

Returns:

The result from executing the ITask object

Throws:

java.rmi.RemoteException - if a network error occurs

setTextAdapter

IRemoteTaskViewAdapter setTextAdapter(IRemoteTaskViewAdapter clientTVAStub)
                               throws java.rmi.RemoteException

Sets this object's IRemoteTaskViewAdapter stub so that it can print strings out on the client's user interface. Returns an IRemoteTaskViewAdapter STUB that will enable the remote client to print strings out on the local compute engine's user interface.
Upon receiving the remote client's IRemoteTaskViewAdapter stub, this method should immediately test the stub by using it to send a status message to the client.
Upon receiving the return value of this method, the remote client should immediately test the stub by using it to send a status message to back to the compute server.

Parameters:

clientTVA - the task view adapter STUB to for the server to use.

Returns:

An adapter STUB to the ICompute server's view.

Throws:

java.rmi.RemoteException - if a network error occurs.