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. The pattern matching inside behavior should invoke matchSenderAndID to ensure the received message is in fact the one that we were 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

Instance Constructors

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

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
}
```
Will cause the orchestrator to fail.
abstract def createMessage(correlationId: CorrelationId): 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 asInstanceOf[T0]: T0

Definition Classes
Any
final def canStart: Boolean

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dependencies: Set[Task]
val description: String
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.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def finish(receivedMessage: Any, correlationId: CorrelationId): Unit

Signals that this task has finished.
Signals that this task has finished.
receivedMessage
the received message that signaled this task has finished.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def hasFinished: Boolean

returns
whether this task status is Finished.
def hashCode(): Int

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

Definition Classes
Any
final def isWaiting: Boolean

returns
whether this task status is Waiting.
final def matchSenderAndId(correlationId: CorrelationId): Boolean

correlationId
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 delivery id resolved from the correlation id is the expected delivery id for this task. 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 error will be logged.
We first persist that the message was sent, then we send it. If the Orchestrator is recovering then we just send the message because there is no need to persist that the message was sent.

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

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

Definition Classes
AnyRef
final def terminateEarly(receivedMessage: Any, correlationId: CorrelationId): 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 onEarlyTermination will be invoked in the orchestrator. · The method onFinish will NEVER be called even if the only tasks needed to finish the orchestrator are already waiting and the responses are received. You can always call onFinish from inside onEarlyTermination to implement the same termination strategy in both cases.
def toString(): String

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

The TaskStatus representation 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( ... )
def withLoggingPrefix(message: ⇒ String): String

Related Docs: object Task | package akkastrator

abstract class Task extends AnyRef

Instance Constructors

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

Abstract Value Members

abstract def behavior: Receive

abstract def createMessage(correlationId: CorrelationId): Any

abstract val destination: ActorPath

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def canStart: Boolean

def clone(): AnyRef

val dependencies: Set[Task]

val description: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def expectedDeliveryId: Option[DeliveryId]

def finalize(): Unit

final def finish(receivedMessage: Any, correlationId: CorrelationId): 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 matchSenderAndId(correlationId: 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, correlationId: CorrelationId): 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 AnyRef

Inherited from Any

Ungrouped