Task

Instance Constructors

new Task(description: String, dependencies: Set[Task] = Set.empty)

Type Members

final type ID = CorrelationId

Definition Classes
Task → AbstractTask

Abstract Value Members

abstract def behavior: akka.actor.Actor.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.
Definition Classes
AbstractTask
abstract def createMessage(id: ID): Any

The constructor of the message to be sent.
The constructor of the message to be sent.

Definition Classes
AbstractTask
abstract val destination: ActorPath

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

Definition Classes
AbstractTask

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 ID2Ids(id: CorrelationId): (CorrelationId, DeliveryId)

Attributes
protected[pt.tecnico.dsi.akkastrator]
Definition Classes
Task → AbstractTask
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def canStart: Boolean

returns
whether this task status is Unstarted and all its dependencies have finished.

Definition Classes
AbstractTask
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final val color: String

Definition Classes
AbstractTask
final def deliveryId2ID(deliveryId: DeliveryId): CorrelationId

Converts the deliveryId obtained from the deliver method of akka-persistence to the ID this task handles.
Converts the deliveryId obtained from the deliver method of akka-persistence to the ID this task handles.

Attributes
protected[pt.tecnico.dsi.akkastrator]
Definition Classes
Task → AbstractTask
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def expectedDeliveryId: Option[DeliveryId]

returns
the current expected deliveryId of this Task.

Definition Classes
AbstractTask
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def finish(receivedMessage: Any, id: ID): 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.
receivedMessage
the message which prompted the finish.
id
the id obtained from the message.

Definition Classes
AbstractTask
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def hasFinished: Boolean

returns
whether this task status is Finished.

Definition Classes
AbstractTask
def hashCode(): Int

Definition Classes
AnyRef → Any
final val index: Int

Definition Classes
Task → AbstractTask
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isWaiting: Boolean

returns
whether this task status is Waiting.

Definition Classes
AbstractTask
final def matchId(id: Long): Boolean

This method simply calls matchSenderAndId.
This method simply calls matchSenderAndId.

Definition Classes
Task → AbstractTask
final def matchSenderAndId(id: CorrelationId): Boolean

id
the correlationId obtained from the received message.
returns
true if · This task status is Waiting · The actor path of the sender is the same as destination. · The deliveryId resolved from the correlationId is the same as the expectedDeliveryId. false otherwise.
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 start(): Unit

Starts the execution of this task.
Starts the execution of this task. If this task is already Waiting or Finished an exception will be thrown. We first persist that the message was sent (unless the orchestrator is recovering), then we send it.

Attributes
protected[pt.tecnico.dsi.akkastrator]
Definition Classes
AbstractTask
final def status: Status

returns
the current status of this Task.

Definition Classes
AbstractTask
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def terminateEarly(receivedMessage: Any, id: ID): Unit

This will cause this task orchestrator to terminate early.
This will cause this task orchestrator to terminate early.
An early termination will have the following effects:
- This task will be finished.
- Every unstarted task will be prevented from starting even if its dependencies have finished.
- Tasks that are waiting will remain untouched and the orchestrator will still be prepared to handle their responses.
- The method onFinish will never be called even if the only tasks needed to finish the orchestrator are already waiting and their responses are received.
- The method onEarlyTermination will be invoked in the orchestrator.
Definition Classes
AbstractTask
def toString(): String

Definition Classes
AbstractTask → AnyRef → Any
final def toTaskStatus: TaskStatus

The TaskStatus representation of this task.
The TaskStatus representation of this task.

Definition Classes
AbstractTask
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( ... )
def withLoggingPrefix(message: ⇒ String): String

Definition Classes
AbstractTask

Related Doc: package DistinctIdsOrchestrator

abstract class Task extends AbstractTask[Task]

Instance Constructors

new Task(description: String, dependencies: Set[Task] = Set.empty)

Type Members

final type ID = CorrelationId

Abstract Value Members

abstract def behavior: akka.actor.Actor.Receive

abstract def createMessage(id: ID): Any

abstract val destination: ActorPath

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def ID2Ids(id: CorrelationId): (CorrelationId, DeliveryId)

final def asInstanceOf[T0]: T0

final def canStart: Boolean

def clone(): AnyRef

final val color: String

final def deliveryId2ID(deliveryId: DeliveryId): CorrelationId

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def expectedDeliveryId: Option[DeliveryId]

def finalize(): Unit

final def finish(receivedMessage: Any, id: ID): Unit

final def getClass(): Class[_]

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 matchSenderAndId(id: CorrelationId): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def start(): Unit

final def status: Status

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

final def terminateEarly(receivedMessage: Any, id: ID): Unit

def toString(): String

final def toTaskStatus: TaskStatus

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withLoggingPrefix(message: ⇒ String): String

Inherited from AbstractTask[Task]

Inherited from AnyRef

Inherited from Any

Ungrouped