Task

A task corresponds to sending a message to an actor, handling its response and possibly mutate the internal state of the Orchestrator.

The answer(s) to the sent message must be handled in behavior. behavior must invoke finish when no further processing is necessary or terminateEarly if the received message will prevent subsequent tasks from executing properly.

The pattern matching inside behavior must invoke matchId to ensure the received message is in fact the one that this task its waiting to receive.

The internal state of the orchestrator might be mutated inside behavior.

This class is very tightly coupled with Orchestrator and the reverse is also true. Because of this you can only create instances of Task inside an orchestrator.

Linear Supertypes

AnyRef, Any

Known Subclasses

TaskBundle

Instance Constructors

new Task(description: String, dependencies: Set[Task[_]] = Set.empty)(implicit orchestrator: AbstractOrchestrator)

Abstract Value Members

abstract def behavior: Receive

The behavior of this task.
The behavior of this task. This is akin to the receive method of an actor, except for the fact that an all catching pattern match will cause the orchestrator to fail. For example:
```
def behavior = Receive {
  case m => //Some code
}
```
This will cause the orchestrator to fail because the messages won't be handled by the correct tasks.
abstract def createMessage(id: Long): Any

The constructor of the message to be sent.
abstract val destination: ActorPath

The ActorPath to whom this task will send the message(s).

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def abort(receivedMessage: Serializable, id: Long): Unit

Causes this task and its orchestrator to abort.
Causes this task and its orchestrator to abort. This will have the following effects:
1. This task will change its state to Aborted. 2. Every unstarted task that depends on this one will never be started. This will happen because a task can only start if its dependencies have finished and this task did not finish. 3. Waiting tasks will be untouched and the orchestrator will still be prepared to handle their responses. 4. The method onFinish will never be called. Similarly to the unstarted tasks, onFinish will only be invoked if all tasks have finished and this task did not finish. 5. The method onAbort will be invoked in the orchestrator.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def canEqual(other: Any): Boolean
final def canStart: Boolean

returns
whether this task state is Unstarted and all its dependencies have finished.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val color: String
val dependencies: Set[Task[_]]
val description: String
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
Task → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def finish(receivedMessage: Serializable, id: Long, result: R): Unit

Finishes this task, which implies:
Finishes this task, which implies:
1. Tasks that depend on this one will be started. 2. Messages that would be handled by this task will no longer be handled.
Finishing an already finished task will throw an exception.
receivedMessage
the message which prompted the finish.
id
the id obtained from the message.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def hasAborted: Boolean
final def hasFinished: Boolean
def hashCode(): Int

Definition Classes
Task → AnyRef → Any
final val index: Int
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isWaiting: Boolean
final def matchId(id: Long): Boolean
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def result: Option[R]

returns
The result of this task. A task will only have a result if it is finished.
final def start(): Unit

Attributes
protected[pt.tecnico.dsi.akkastrator]
final def state: TaskState

returns
the current state of this Task.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Task → AnyRef → Any
final def toTaskReport: TaskReport

The immutable TaskReport of this task.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package akkastrator

abstract class Task[R] extends AnyRef

Instance Constructors

new Task(description: String, dependencies: Set[Task[_]] = Set.empty)(implicit orchestrator: AbstractOrchestrator)

Abstract Value Members

abstract def behavior: Receive

abstract def createMessage(id: Long): Any

abstract val destination: ActorPath

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def abort(receivedMessage: Serializable, id: Long): Unit

final def asInstanceOf[T0]: T0

def canEqual(other: Any): Boolean

final def canStart: Boolean

def clone(): AnyRef

val color: String

val dependencies: Set[Task[_]]

val description: String

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def finalize(): Unit

final def finish(receivedMessage: Serializable, id: Long, result: R): Unit

final def getClass(): Class[_]

final def hasAborted: Boolean

final def hasFinished: Boolean

def hashCode(): Int

final val index: Int

final def isInstanceOf[T0]: Boolean

final def isWaiting: Boolean

final def matchId(id: Long): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def result: Option[R]

final def start(): Unit

final def state: TaskState

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def toTaskReport: TaskReport

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped