p

group

package group

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. class GroupActionHandler extends AnyRef

    Handles group action messages.

    Handles group action messages. Those messages are of type GroupMsg with a JSON object that contains an 'action' field. It was received by a GroupDispatcher and comes from a client via a GroupChannelActor.

    Annotations
    @Singleton()
  2. class GroupActionMsgBuilder extends AnyRef

    Utility class that builds GroupMsgs.

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

    Annotations
    @Singleton()
  3. class GroupAdministration extends AnyRef

    This class handles the joining, leaving, and reassigning of group members.

    This class handles the joining, leaving, and reassigning of group members. A group's state is stored in a GroupResult. Group dispatchers manage group channels (the handlers of the WebSockets). Members of a group are identified by the study result ID (which represents a particular study run).

    Annotations
    @Singleton()
  4. class GroupChannelActor extends Actor

    GroupChannelActor is an Akka Actor that represents the group channel's WebSocket.

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

    A GroupChannelActor is only opened after a study run (identified by a StudyResult) joined a group, which is done in the GroupAdministration. Group data (e.g. who is member) are persisted in a GroupResult entity. A GroupChannelActor is closed after the StudyResult left the GroupResult.

    A GroupChannelActor belongs to a GroupDispatcher. A GroupChannelActor is created by the GroupChannel service. It registers and unregisters itself with the GroupDispatcher.

  5. class GroupChannelRegistry extends AnyRef

    This class stores the members (channels) of a GroupDispatcher.

    This class stores the members (channels) of a GroupDispatcher. It is essentially a wrapper around a bidirectional map that stores the study result IDs together with their corresponding GroupChannelActors.

    A Registry does not define who is a member - it just stores the open channels. Therefore, it is possible that a client is a member but currently doesn't have an open channel.

  6. class GroupDispatcher extends AnyRef
  7. class GroupDispatcherRegistry extends AnyRef

    The GroupDispatcherRegistry keeps track of all GroupDispatchers.

    The GroupDispatcherRegistry keeps track of all GroupDispatchers.

    Annotations
    @Singleton()

Value Members

  1. object GroupDispatcher

    A GroupDispatcher is responsible for distributing messages (GroupMsg) within a group.

    A GroupDispatcher is responsible for distributing messages (GroupMsg) within a group. Thus, it is the central class handling a group.

    A GroupDispatcher only handles the GroupChannelActors but is not responsible for the actual joining of a study run to a group (a StudyResult to a GroupResult). This is done before creating a GroupDispatcher by the GroupAdministration, which persists all data in a GroupResult. Who is a member in a group is stored in a GroupResult.

    A GroupChannelActor is only opened after a StudyResult joined a GroupResult, which is done in the GroupAdministration. Group data (e.g., who is member) are persisted in a GroupResult entity. A GroupChannelActor is closed after the StudyResult left the group.

    A GroupChannelActor registers and unregisters itself in a GroupDispatcher.

    A new GroupDispatcher is created by the GroupDispatcherRegistry. If a GroupDispatcher has no more members, it closes itself.

    A GroupDispatcher handles all messages specified in the GroupDispatcherProtocol. There are fundamentally three different message types: 1) group session patches, 2) broadcast messages, and 3) direct messages for a particular group member.

    The group session patches are JSON Patches after RFC 6902 and used to describe changes in the group session data. The session data are stored in the GroupResult.

Ungrouped