batch
package batch
- Alphabetic
- Public
- Protected
Type Members
- 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()
- class BatchActionMsgBuilder extends AnyRef
Utility class that builds BatchMsgs.
Utility class that builds BatchMsgs. So it mostly handles the JSON creation.
- Annotations
- @Singleton()
- class BatchChannelActor extends Actor
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 to its BatchDispatcher. It closes if the WebSocket is closed or externally, by the BatchDispatcher. While closing down, it unregisters from the BatchDispatcher.
- class BatchChannelRegistry extends AnyRef
This class stores the members (channels) of a BatchDispatcher.
This class stores the members (channels) of a BatchDispatcher. It is essentially a wrapper around a bidirectional map that stores the study result IDs together with their corresponding BatchChannelActors specified by an ActorRef.
A Registry does not define who is a member - it just stores the open channels.
- class BatchDispatcher extends AnyRef
- class BatchDispatcherRegistry extends AnyRef
The BatchDispatcherRegistry keeps track of all BatchDispatchers.
The BatchDispatcherRegistry keeps track of all BatchDispatchers.
- Annotations
- @Singleton()
- class BatchDispatcherTestScala extends AnyRef
Value Members
- object BatchDispatcher
A BatchDispatcher is responsible for distributing messages (BatchMsg) within a batch.
A BatchDispatcher is responsible for distributing messages (BatchMsg) within a batch.
A BatchDispatcher handles and distributes messages between currently active 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.
A BatchChannelActor is always opened during initialization of jatos.js (where a GroupChannelActor is opened only after the group was joined). A BatchChannelActor registers and unregisters itself in a BatchDispatcher.
A new BatchDispatcher is created by the BatchDispatcherRegistry. If a BatchDispatcher has no more members, it closes itself.
- object BatchDispatcherTestScala