Packages

•  package root

  Definition Classes

  root

•  package group

  Definition Classes

  root

•  object GroupDispatcher

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

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

  A GroupDispatcher only handles the GroupChannels but is not responsible for the actual joining of a GroupResult. This is done prior to creating a GroupDispatcher by the GroupAdministration which persists all data in a GroupResult. Who's member in a group is ultimately defined by the GroupResult.

  A GroupChannelActor is only opened after a StudyResult joined a GroupResult, 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 group.

  A GroupChannelActor registers in a GroupDispatcher by sending the RegisterChannel message and unregisters by sending a UnregisterChannel message.

  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.

  Definition Classes

  group

• Factory
• GroupAction
• GroupActionJsonKey
• GroupMsg
• JoinedGroup
• LeftGroup
• PoisonChannel
• PoisonEmptyDispatcher
• ReassignChannel
• RegisterChannel
• TellWhom
• UnregisterChannel

group.GroupDispatcher

Factory