object BatchDispatcher

A BatchDispatcher is an Akka Actor responsible for distributing messages (BatchMsg) within a batch.

A BatchChannelActor is always opened during initialization of jatos.js (where a GroupChannelActor is opened only after the group was joined).

A BatchChannelActor registers in a BatchDispatcher by sending the RegisterChannel message and unregisters by sending a UnregisterChannel message.

A new BatchDispatcher is created by the BatchDispatcherRegistry. If a BatchDispatcher has no more members it closes itself.

A BatchDispatcher handles and distributes messages between currently active the members of a batch. These messages are essentially JSON Patches after RFC 6902 and used to describe changes in the batch session data. The session data are stored and persisted with the Batch.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BatchDispatcher
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class BatchMsg(json: JsObject, tellWhom: TellWhom = TellWhom.Unknown) extends Product with Serializable

    Message used for an action message.

    Message used for an action message. It has a JSON string and the JSON contains an 'action' field. Additionally it can be addressed with TellWhom.

  2. trait Factory extends AnyRef
  3. case class PoisonChannel(studyResultId: Long) extends Product with Serializable

    Message that forces a BatchChannelActor to close itself.

    Message that forces a BatchChannelActor to close itself. Send from the BatchChannel service to a BatchDispatcher and there it will be forwarded to the right BatchChannelActor.

  4. case class RegisterChannel(studyResultId: Long) extends Product with Serializable

    Message a BatchChannelActor can send to register in a BatchDispatcher.

  5. case class UnregisterChannel(studyResultId: Long) extends Product with Serializable

    Message an BatchChannelActor can send to its BatchDispatcher to indicate it's closure.

Value Members

  1. object BatchAction extends Enumeration

    All possible batch actions a batch action message can have.

    All possible batch actions a batch action message can have. They are used as values in JSON message's action field.

  2. object BatchActionJsonKey extends Enumeration

    Strings used as keys in the batch action JSON

  3. object TellWhom extends Enumeration