org.objectweb.proactive.Body Interface Reference

Inheritance diagram for org.objectweb.proactive.Body:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.proactive.Body:

Collaboration graph
[legend]
List of all members.

Public Member Functions

boolean isAlive ()
 Returns whether the body is alive or not.
boolean isActive ()
 Returns whether the body is active or not.
void blockCommunication ()
 blocks all incoming communications.
void acceptCommunication ()
 Signals the body to accept all incoming communications.
void enterInThreadStore ()
 Allows the calling thread to enter in the ThreadStore of this body.
void exitFromThreadStore ()
 Allows the calling thread to exit from the ThreadStore of this body.
UniversalBody checkNewLocation (UniqueID uniqueID)
 Tries to find a local version of the body of id uniqueID.
UniversalBody getShortcutTargetBody (ItfID functionalItfID)
 Returns the body that is the target of this shortcut for this component interface.
void setPolicyServer (PolicyServer server)
 set the policy server of the active object
void updateNodeURL (String newNodeURL)
 Set the nodeURL of this body.

Detailed Description

An object implementing this interface is an implementation of the non fonctionnal part of an ActiveObject. This representation is local to the ActiveObject. By contrast there is a remote representation of Body that can be accessed by distant object.

UniversalBody defines the remote accessible part of the body while LocalBody defines the local accessible part of the body.

The body of an ActiveObject provides needed services such as a the ability to sent and receive request and reply.

The interface also defines how the activity methods of an active object sees its Body.

A body has 2 associated states :

Note that a thread can be alive but not active, such as a forwarder that just forward request to another peer.

Author:
ProActive Team
Version:
1.0, 2001/10/23
Since:
ProActive 0.9

Definition at line 69 of file Body.java.


Member Function Documentation

boolean org.objectweb.proactive.Body.isAlive (  ) 

Returns whether the body is alive or not.

The body is alive as long as it is processing request and reply

Returns:
whether the body is alive or not.

Implemented in org.objectweb.proactive.core.body.AbstractBody, and org.objectweb.proactive.ext.security.EncryptedBody.

Referenced by org.objectweb.proactive.p2p.service.P2PFirstContact.runActivity().

boolean org.objectweb.proactive.Body.isActive (  ) 

Returns whether the body is active or not.

The body is active as long as it has an associated thread running to serve the requests by calling methods on the active object.

Returns:
whether the body is active or not.

Implemented in org.objectweb.proactive.core.body.AbstractBody, org.objectweb.proactive.core.component.body.ComponentBodyImpl, and org.objectweb.proactive.ext.security.EncryptedBody.

Referenced by org.objectweb.proactive.Service.fifoServing(), org.objectweb.proactive.Service.lifoServing(), org.objectweb.proactive.p2p.service.P2PAcquaintanceManager.runActivity(), org.objectweb.proactive.p2p.loadbalancer.P2PLoadBalancer.runActivity(), org.objectweb.proactive.core.component.body.ComponentActivity.runActivity(), and org.objectweb.proactive.loadbalancing.LoadBalancer.sendActiveObjectsTo().

void org.objectweb.proactive.Body.blockCommunication (  ) 

blocks all incoming communications.

After this call, the body cannot receive any request or reply.

Implemented in org.objectweb.proactive.core.body.AbstractBody, and org.objectweb.proactive.ext.security.EncryptedBody.

Referenced by org.objectweb.proactive.core.body.ft.checkpointing.Checkpoint.recover().

void org.objectweb.proactive.Body.acceptCommunication (  ) 

Signals the body to accept all incoming communications.

This call undo a previous call to blockCommunication.

Implemented in org.objectweb.proactive.core.body.AbstractBody, and org.objectweb.proactive.ext.security.EncryptedBody.

UniversalBody org.objectweb.proactive.Body.checkNewLocation ( UniqueID  uniqueID  ) 

Tries to find a local version of the body of id uniqueID.

If a local version is found it is returned. If not, tries to find the body of id uniqueID in the known body of this body. If a body is found it is returned, else null is returned.

Parameters:
uniqueID the id of the body to lookup
Returns:
the last known version of the body of id uniqueID or null if not known

Implemented in org.objectweb.proactive.core.body.AbstractBody, and org.objectweb.proactive.ext.security.EncryptedBody.

UniversalBody org.objectweb.proactive.Body.getShortcutTargetBody ( ItfID  functionalItfID  ) 

Returns the body that is the target of this shortcut for this component interface.

Parameters:
functionalItfID the id of the interface on which the shortcut is available
Returns:
the body that is the target of this shortcut for this interface

Implemented in org.objectweb.proactive.core.body.AbstractBody, and org.objectweb.proactive.ext.security.EncryptedBody.

void org.objectweb.proactive.Body.setPolicyServer ( PolicyServer  server  ) 

set the policy server of the active object

Parameters:
server the policy server

Implemented in org.objectweb.proactive.core.body.AbstractBody, and org.objectweb.proactive.ext.security.EncryptedBody.

void org.objectweb.proactive.Body.updateNodeURL ( String  newNodeURL  ) 

Set the nodeURL of this body.

Parameters:
newNodeURL the new URL of the node

Implemented in org.objectweb.proactive.core.body.BodyImpl, org.objectweb.proactive.core.body.HalfBody, and org.objectweb.proactive.ext.security.EncryptedBody.


The documentation for this interface was generated from the following file:
Generated on Mon Jan 22 15:16:13 2007 for ProActive by  doxygen 1.5.1