object GroupDispatcher

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.

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

Type Members

  1. trait Factory extends AnyRef
  2. case class GroupMsg(json: JsObject, tellWhom: TellWhom = TellWhom.Unknown) extends Product with Serializable

    Message format used for communication in the group channel between the GroupDispatcher and the group members.

    Message format used for communication in the group channel between the GroupDispatcher and the group members. A GroupMsg contains a JSON node. If the JSON has an 'action' key, it is a group action message. With 'tellWhom' the recipient can be specified.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. object GroupAction extends Enumeration
  21. object GroupActionJsonKey extends Enumeration

    Strings used as keys in the group action JSON

  22. object TellWhom extends Enumeration

Inherited from AnyRef

Inherited from Any

Ungrouped