object GroupChannelActor

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 be opened after a study run (identified by a StudyResult) joined a group, which is done in the GroupAdministration. Group data (e.g. who's 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 and registers itself by sending a RegisterChannel message to its GroupDispatcher. It closes down after receiving a PoisonChannel message or if the WebSocket is closed. While closing down it unregisters from the GroupDispatcher by sending a UnregisterChannel message. A GroupChannelActor can, if it's told to, reassign itself to a different GroupDispatcher.

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

Value Members

  1. def props(out: ActorRef, studyResultId: Long, groupDispatcher: ActorRef): Props