Class

pt.tecnico.dsi.akkastrator

Orchestrator

Related Doc: package akkastrator

Permalink

abstract class Orchestrator extends AbstractOrchestrator

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Orchestrator
  2. AbstractOrchestrator
  3. IdImplicits
  4. ActorLogging
  5. AtLeastOnceDelivery
  6. AtLeastOnceDeliveryLike
  7. PersistentActor
  8. Eventsourced
  9. PersistenceRecovery
  10. PersistenceIdentity
  11. PersistenceStash
  12. StashFactory
  13. Stash
  14. RequiresMessageQueue
  15. UnrestrictedStash
  16. StashSupport
  17. Snapshotter
  18. Actor
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Orchestrator(settings: Settings = new Settings())

    Permalink

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor
  2. final type S = State

    Permalink
    Definition Classes
    OrchestratorAbstractOrchestrator
  3. final type T = Task

    Permalink
    Definition Classes
    OrchestratorAbstractOrchestrator
  4. abstract class Task extends AbstractTask[Task]

    Permalink
  5. abstract class TaskProxy extends AbstractTask[TaskProxy]

    Permalink
    Definition Classes
    AbstractOrchestrator

Abstract Value Members

  1. abstract def persistenceId: String

    Permalink
    Definition Classes
    PersistenceIdentity

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def aroundPostRestart(reason: Throwable): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  5. def aroundPostStop(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    AtLeastOnceDeliveryLike → Eventsourced → Actor
  6. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    AtLeastOnceDeliveryLike → Eventsourced → Actor
  7. def aroundPreStart(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  8. def aroundReceive(receive: Receive, message: Any): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    AtLeastOnceDeliveryLike → Eventsourced → Actor
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def confirmDelivery(deliveryId: Long): Boolean

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  12. implicit val context: ActorContext

    Permalink
    Definition Classes
    Actor
  13. def deferAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Eventsourced
  14. def deleteMessages(toSequenceNr: Long): Unit

    Permalink
    Definition Classes
    Eventsourced
  15. def deleteSnapshot(sequenceNr: Long): Unit

    Permalink
    Definition Classes
    Snapshotter
  16. def deleteSnapshots(criteria: SnapshotSelectionCriteria): Unit

    Permalink
    Definition Classes
    Snapshotter
  17. def deliver(destination: ActorSelection)(deliveryIdToMessage: (Long) ⇒ Any): Unit

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  18. def deliver(destination: ActorPath)(deliveryIdToMessage: (Long) ⇒ Any): Unit

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  21. def extraCommands: akka.actor.Actor.Receive

    Permalink

    Override this method to add extra commands that are always handled by this orchestrator (except when recovering).

    Override this method to add extra commands that are always handled by this orchestrator (except when recovering).

    Definition Classes
    AbstractOrchestrator
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  24. def getDeliverySnapshot: AtLeastOnceDeliverySnapshot

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. def internalStashOverflowStrategy: StashOverflowStrategy

    Permalink
    Definition Classes
    PersistenceStash
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def journalPluginId: String

    Permalink
    Definition Classes
    PersistenceIdentity
  29. def lastSequenceNr: Long

    Permalink
    Definition Classes
    Eventsourced
  30. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

    Permalink
    Definition Classes
    Snapshotter
  31. def log: LoggingAdapter

    Permalink
    Definition Classes
    ActorLogging
  32. implicit def longToCorrelationId(l: Long): CorrelationId

    Permalink
    Definition Classes
    IdImplicits
  33. implicit def longToDeliveryId(l: Long): DeliveryId

    Permalink
    Definition Classes
    IdImplicits
  34. def maxUnconfirmedMessages: Int

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  35. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  36. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. def numberOfUnconfirmed: Int

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  39. def onEarlyTermination(instigator: T, message: Any, tasks: Map[Status, Seq[T]]): Unit

    Permalink

    User overridable callback.

    User overridable callback. Its called when a task requests an early termination. Empty default implementation.

    instigator

    the task that initiated the early termination.

    message

    the message that caused the early termination.

    tasks

    Map with the tasks status at the moment of early termination.

    Definition Classes
    AbstractOrchestrator
    Note

    if you invoke become/unbecome inside this method, the contract that states "Tasks that are waiting will remain untouched and the orchestrator will still be prepared to handle their responses" will no longer be guaranteed.

  40. def onFinish(): Unit

    Permalink

    User overridable callback.

    User overridable callback. Its called once every task finishes. By default logs that the Orchestrator has finished then stops it.

    You can use this to implement your termination strategy.

    Definition Classes
    AbstractOrchestrator
  41. def onPersistFailure(cause: Throwable, event: Any, seqNr: Long): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
  42. def onPersistRejected(cause: Throwable, event: Any, seqNr: Long): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
  43. def onRecoveryFailure(cause: Throwable, event: Option[Any]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
  44. final def orchestratorCommand: akka.actor.Actor.Receive

    Permalink
    Definition Classes
    AbstractOrchestrator
  45. def persist[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Eventsourced
  46. def persistAll[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Eventsourced
  47. def persistAllAsync[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Eventsourced
  48. def persistAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Eventsourced
  49. def postRestart(reason: Throwable): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  50. def postStop(): Unit

    Permalink
    Definition Classes
    UnrestrictedStash → Actor
  51. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Definition Classes
    UnrestrictedStash → Actor
  52. def preStart(): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  53. def receive: Receive

    Permalink
    Definition Classes
    PersistentActor → Actor
  54. final def receiveCommand: akka.actor.Actor.Receive

    Permalink
    Definition Classes
    AbstractOrchestrator → Eventsourced
  55. final def receiveRecover: akka.actor.Actor.Receive

    Permalink
    Definition Classes
    AbstractOrchestrator → Eventsourced
  56. final def recoverStateOnMessageReceived(task: Task, correlationId: CorrelationId, deliveryId: DeliveryId): Unit

    Permalink
    Attributes
    protected[pt.tecnico.dsi.akkastrator]
    Definition Classes
    OrchestratorAbstractOrchestrator
  57. def recovery: Recovery

    Permalink
    Definition Classes
    PersistenceRecovery
  58. def recoveryFinished: Boolean

    Permalink
    Definition Classes
    Eventsourced
  59. def recoveryRunning: Boolean

    Permalink
    Definition Classes
    Eventsourced
  60. def redeliverInterval: FiniteDuration

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  61. def redeliveryBurstLimit: Int

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  62. def saveSnapshot(snapshot: Any): Unit

    Permalink
    Definition Classes
    Snapshotter
  63. def saveSnapshotRoughlyEveryXMessages: Int

    Permalink

    Every X messages a snapshot will be saved.

    Every X messages a snapshot will be saved. Set to 0 to disable automatic saving of snapshots. By default this method returns the value defined in the configuration.

    Roughly every X messages a snapshot will be saved. Set to 0 to disable automatic saving of snapshots. This is just a rough value because the orchestrator will not save it in the snapshots. In fact it will not save it at all. Instead the value of lastSequenceNr will be used to estimate how many messages have been processed.

    You can trigger a save snapshot manually by sending a SaveSnapshot message to this orchestrator.

    Definition Classes
    AbstractOrchestrator
  64. implicit final val self: ActorRef

    Permalink
    Definition Classes
    Actor
  65. final def sender(): ActorRef

    Permalink
    Definition Classes
    Actor
  66. def setDeliverySnapshot(snapshot: AtLeastOnceDeliverySnapshot): Unit

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  67. def snapshotPluginId: String

    Permalink
    Definition Classes
    PersistenceIdentity
  68. def snapshotSequenceNr: Long

    Permalink
    Definition Classes
    Eventsourced → Snapshotter
  69. def snapshotterId: String

    Permalink
    Definition Classes
    Eventsourced → Snapshotter
  70. def startTasks(): Unit

    Permalink

    User overridable callback.

    User overridable callback. Its called to start the Tasks. By default logs that the orchestrator started and sends it the StartReadyTasks message.

    You can override this to prevent the Orchestrator from starting right away. However that strategy will only be effective the first time the orchestrator starts, that is, if this orchestrator restarts with one task already finished, then that task will send the StartReadyTasks so that tasks that depend on it can start.

    Definition Classes
    AbstractOrchestrator
  71. def stash(): Unit

    Permalink
    Definition Classes
    StashSupport
  72. final def state: S

    Permalink
    Definition Classes
    AbstractOrchestrator
  73. final def state_=(state: S): Unit

    Permalink
    Definition Classes
    AbstractOrchestrator
  74. def supervisorStrategy: SupervisorStrategy

    Permalink
    Definition Classes
    Actor
  75. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  76. final def tasks: IndexedSeq[T]

    Permalink
    Definition Classes
    AbstractOrchestrator
  77. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  78. final def toT(proxy: TaskProxy): T

    Permalink
    Definition Classes
    OrchestratorAbstractOrchestrator
  79. def unhandled(message: Any): Unit

    Permalink
    Definition Classes
    Eventsourced → Actor
  80. def unstashAll(): Unit

    Permalink
    Definition Classes
    Eventsourced → StashSupport
  81. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. def warnAfterNumberOfUnconfirmedAttempts: Int

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike

Deprecated Value Members

  1. def persist[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Eventsourced
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) use persistAll instead

  2. def persistAsync[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Eventsourced
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) use persistAllAsync instead

Inherited from AbstractOrchestrator

Inherited from IdImplicits

Inherited from ActorLogging

Inherited from AtLeastOnceDelivery

Inherited from AtLeastOnceDeliveryLike

Inherited from PersistentActor

Inherited from Eventsourced

Inherited from PersistenceRecovery

Inherited from PersistenceIdentity

Inherited from PersistenceStash

Inherited from StashFactory

Inherited from Stash

Inherited from RequiresMessageQueue[DequeBasedMessageQueueSemantics]

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Snapshotter

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped