ibis.constellation

Interface Constellation

public interface Constellation

Main interface to Constellation.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
boolean	activate() Activate this Constellation implementation.
void	done() Terminate Constellation.
Timer	getOverallTimer() Returns the overall timer.
Timer	getTimer() Creates a Timer without device, thread, or action name.
Timer	getTimer(java.lang.String device, java.lang.String thread, java.lang.String action) Creates a Timer with the specified device, thread, and action name.
ConstellationIdentifier	identifier() Returns a unique identifier for this Constellation instance.
boolean	isMaster() Returns true if this Constellation instance is the master, false otherwise.
void	send(Event e) Send an event.
ActivityIdentifier	submit(Activity activity) Submit an activity.

Method Detail

submit

ActivityIdentifier submit(Activity activity)
                   throws NoSuitableExecutorException

Submit an activity. The submitted Activity will be inserted into Constellation and executed if and when a suitable Executor is found. An ActivityIdentifier is returned that can be used to refer to this submitted Activity at a later moment in time. It is up to the user to make sure that this constellation instance has a suitable executor, or, if the contexts don't match, an executor that can be stolen from. In some cases, the system can detect that no suitable executor can be found. In those cases, it throws an exception.

Parameters:

activity - the Activity to submit

Returns:

ActivityIdentifier that can be used to refer to the submitted Activity.

Throws:

NoSuitableExecutorException - is thrown when the system has detected that no suitable executor can be found.

send

void send(Event e)

Send an event.

Parameters:

e - the Event to send.

activate

boolean activate()

Activate this Constellation implementation. Constellation instances start out in in inactive state when they are created. This allows the application to configure Constellation (for example, by setting up the desired combination of distributed and local constellation instances). Upon activation, the Constellation instance will activate all sub-constellations, and activate its own executors, steal pools, event queues, etc.

Returns:

if the Constellation was activated.

done

void done()

Terminate Constellation. When terminating all sub-constellations will be terminated. Termination may also block until all other running constellation instances in a Pool have also decided to terminate.

isMaster

boolean isMaster()

Returns true if this Constellation instance is the master, false otherwise.

Returns:

whether this Constellation instance is the master.

identifier

ConstellationIdentifier identifier()

Returns a unique identifier for this Constellation instance. This identifier can be used to uniquely refer to a running Constellation instance.

Returns:

a string that uniquely identifies this Constellation instance.

getTimer

Timer getTimer(java.lang.String device,
               java.lang.String thread,
               java.lang.String action)

Creates a Timer with the specified device, thread, and action name.

Parameters:

device - the device name

thread - the thread name

action - the action name

Returns:

the Timer object

getTimer

Timer getTimer()

Creates a Timer without device, thread, or action name.

Returns:

the Timer object

getOverallTimer

Timer getOverallTimer()

Returns the overall timer. This timer needs to be started and stopped by the main program.

Returns:

the overall timer.