ibis.constellation

Class Event

java.lang.Object

ibis.constellation.Event

All Implemented Interfaces:

java.io.Serializable

public final class Event
extends java.lang.Object
implements java.io.Serializable

An Event can be used for communication between activities. A common usage is to notify an activity that certain data is available, or that some processing steps have been finished. The data of an event may implement the ByteBuffers interface, to send/receive any ByteBuffers it contains. Constellation will then call the methods of this interface when needed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Event(ActivityIdentifier source, ActivityIdentifier target, java.lang.Object data) Constructs an event with the specified parameters: a source, a target, and its data.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getData() Returns the data object of this event.
ActivityIdentifier	getSource() Returns the identifier of the source activity of this event.
ActivityIdentifier	getTarget() Returns the identifier of the target activity of this event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(ActivityIdentifier source,
             ActivityIdentifier target,
             java.lang.Object data)

Constructs an event with the specified parameters: a source, a target, and its data.

Parameters:

source - the source activity of this event

target - the target activity for this event

data - the data of this event, may be null

Throws:

java.lang.IllegalArgumentException - when either source or target is null or otherwise an illegal activity identifier (not generated by constellation). It is also thrown if the data is not null and not serializable.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSource

public ActivityIdentifier getSource()

Returns the identifier of the source activity of this event.

Returns:

the source activity identifier

getTarget

public ActivityIdentifier getTarget()

Returns the identifier of the target activity of this event.

Returns:

the target activity identifier

getData

public java.lang.Object getData()

Returns the data object of this event.

Returns:

the data object