ch.icosys.popjava.core.interfacebase

Class Interface

java.lang.Object

ch.icosys.popjava.core.interfacebase.Interface

Direct Known Subclasses:

PJMethodHandler

public class Interface
extends java.lang.Object

Interface side of a POP-Java parallel object. This object is the local representative of the parallel object

Field Summary

Fields

Modifier and Type	Field and Description
protected ComboxConnection<?>	combox
protected ObjectDescription	od
protected Broker	parentBroker
protected POPAccessPoint	popAccessPoint

Constructor Summary

Constructors

Constructor and Description
Interface(Broker parentBroker) Default Interface constructor
Interface(Broker parentBroker, POPAccessPoint accessPoint) Create an Interface by giving the access point of the parallel object
Interface(Broker parentBroker, POPAccessPoint accessPoint, ObjectDescription od) Create an Interface by giving the access point of the parallel object

Method Summary

Modifier and Type	Method and Description
int	addRef()
boolean	allocate(java.lang.String objectName) Allocate resource for the associated parallel object
boolean	allocateThroughJobmanager(java.lang.String objectName, POPAccessPoint[] allocatedAccessPoint, POPAccessPoint[] remotejobscontact)
protected boolean	bind(POPAccessPoint accesspoint) Bind the interface with a parallel object (Broker-side)
void	close() Close the combox associated with this interface
int	decRef()
boolean	deserialize(Combox sourceCombox, POPBuffer buffer)
boolean	deserialize(POPBuffer buffer) Deserialize an Interface from a buffer
protected void	finalize() Close everything
POPAccessPoint	getAccessPoint() Return the access point of the parallel object associated with this interface
static AppService	getAppcoreService()
static java.lang.String	getCodeFile(AppService manager, java.lang.String objectName)
ObjectDescription	getOD() Return the object description associated with this interface
POPRemoteCaller	getRemote() Get the remote caller of the host the object is connected to.
protected int	getRequestID()
boolean	isAlive() Check if the parallel object associated with this interface is still alive
void	kill() Kill the associated parallel object
protected void	popDispatch(POPBuffer buffer) Send the buffer content to the broker-side
protected int	popResponse(POPBuffer buffer, int requestId) Receive response from the broker-side
void	release()
boolean	serialize(POPBuffer buffer) Serialization of the Interface into the buffer
void	setAccessPoint(POPAccessPoint accessPoint) Set the access point associated with this interface
void	setOd(ObjectDescription od) Associate an object description with this interface
static boolean	tryLocal(java.lang.String objectName, POPAccessPoint accesspoint, ObjectDescription od) Try a local execution for the associated parallel object

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parentBroker

protected final Broker parentBroker

combox

protected ComboxConnection<?> combox

popAccessPoint

protected POPAccessPoint popAccessPoint

od

protected ObjectDescription od

Constructor Detail

Interface

public Interface(Broker parentBroker)

Default Interface constructor

Interface

public Interface(Broker parentBroker,
                 POPAccessPoint accessPoint)
          throws POPException

Create an Interface by giving the access point of the parallel object

Parameters:

accessPoint - Access point of the parallel object

Throws:

POPException - thrown of the interface cannot be bind with the parallel object

Interface

public Interface(Broker parentBroker,
                 POPAccessPoint accessPoint,
                 ObjectDescription od)
          throws POPException

Create an Interface by giving the access point of the parallel object

Parameters:

accessPoint - Access point of the parallel object

od - A custom OD for specifying possible connection parameters

Throws:

POPException - thrown of the interface cannot be bind with the parallel object

Method Detail

serialize

public boolean serialize(POPBuffer buffer)

Serialization of the Interface into the buffer

Parameters:

buffer - Buffer to serialize in

Returns:

true if the serialization is finished without any problems

deserialize

public boolean deserialize(POPBuffer buffer)

Deserialize an Interface from a buffer

Parameters:

buffer - Buffer to deserialize from

Returns:

True if the deserialization has finished without any problems

getRequestID

protected int getRequestID()

deserialize

public boolean deserialize(Combox sourceCombox,
                           POPBuffer buffer)

getRemote

public POPRemoteCaller getRemote()

Get the remote caller of the host the object is connected to.

Returns:

the remote object connection

getAccessPoint

public POPAccessPoint getAccessPoint()

Return the access point of the parallel object associated with this interface

Returns:

Access point of the associated parallel object

setAccessPoint

public void setAccessPoint(POPAccessPoint accessPoint)

Set the access point associated with this interface

Parameters:

accessPoint - Access point to associate

getOD

public ObjectDescription getOD()

Return the object description associated with this interface

Returns:

ObjectDescription of this interface

setOd

public void setOd(ObjectDescription od)

Associate an object description with this interface

Parameters:

od - Object descritption to associate

release

public void release()

allocate

public boolean allocate(java.lang.String objectName)
                 throws POPException

Allocate resource for the associated parallel object

Parameters:

objectName - Name of the object

Returns:

True if the interface can allocate some resources

Throws:

POPException - thrown if any exception occurred during the allocating process

allocateThroughJobmanager

public boolean allocateThroughJobmanager(java.lang.String objectName,
                                         POPAccessPoint[] allocatedAccessPoint,
                                         POPAccessPoint[] remotejobscontact)

bind

protected boolean bind(POPAccessPoint accesspoint)
                throws POPException

Bind the interface with a parallel object (Broker-side)

Parameters:

accesspoint - Access point of the parallel object (Broker-side)s

Returns:

true if the interface is binded to the broker-side

Throws:

POPException - thrown if any exception occurred during the binding process

addRef

public int addRef()

decRef

public int decRef()

isAlive

public boolean isAlive()

Check if the parallel object associated with this interface is still alive

Returns:

true if the parallel object is alive

kill

public void kill()

Kill the associated parallel object

tryLocal

public static boolean tryLocal(java.lang.String objectName,
                               POPAccessPoint accesspoint,
                               ObjectDescription od)
                        throws POPException

Try a local execution for the associated parallel object

Parameters:

objectName - Name of the object

accesspoint - Output parameter - Access point of the object

od - the object description

Returns:

true if the local execution succeed

Throws:

POPException - thrown if any exception occurred during the creation process

getAppcoreService

public static AppService getAppcoreService()

getCodeFile

public static java.lang.String getCodeFile(AppService manager,
                                           java.lang.String objectName)

popDispatch

protected void popDispatch(POPBuffer buffer)

Send the buffer content to the broker-side

Parameters:

buffer - Buffer to send

popResponse

protected int popResponse(POPBuffer buffer,
                          int requestId)
                   throws POPException

Receive response from the broker-side

Parameters:

buffer - the buffer

Returns:

0 or an exception

Throws:

POPException - connection failed

close

public void close()

Close the combox associated with this interface

finalize

protected void finalize()
                 throws java.lang.Throwable

Close everything

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable