p

batch

package batch

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. class BatchActionHandler extends AnyRef

    Handles batch action messages received by a BatchDispatcher from a client via a batch channel.

    Handles batch action messages received by a BatchDispatcher from a client via a batch channel.

    Annotations
    @Singleton()
  2. class BatchActionMsgBuilder extends AnyRef

    Utility class that builds BatchMsgs.

    Utility class that builds BatchMsgs. So it mostly handles the JSON creation.

    Annotations
    @Singleton()
  3. class BatchChannelActor extends Actor
  4. class BatchDispatcher extends Actor
  5. class BatchDispatcherRegistry extends Actor with InjectedActorSupport
    Annotations
    @Singleton()

Value Members

  1. object BatchChannelActor

    BatchChannelActor is an Akka Actor that represents the batch channel's WebSocket.

    BatchChannelActor is an Akka Actor that represents the batch channel's WebSocket. A batch channel is a WebSocket connecting a client who's running a study with the JATOS server.

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

    A BatchChannelActor belongs to a BatchDispatcher. A BatchChannelActor is created by the BatchChannel service and registers itself by sending a RegisterChannel message to its BatchDispatcher. It closes down after receiving a PoisonChannel message or if the WebSocket is closed. While closing down it unregisters from the BatchDispatcher by sending a UnregisterChannel message. A BatchChannelActor can, if it's told to, reassign itself to a different BatchDispatcher.

  2. object BatchDispatcher

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

    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.

  3. object BatchDispatcherRegistry

    A BatchDispatcherRegistry is an Akka Actor that keeps track of all BatchDispatcher Actors.

Ungrouped