object GroupDispatcher
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.
- Alphabetic
- By Inheritance
- GroupDispatcher
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait Factory extends AnyRef
- 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 a key named 'recipient' the message is intended for one particular group member - otherwise it's a broadcast message. If the JSON has a 'action' key it is an group action message.
The parameter 'tellWhom' can be used to address the recipient.
- case class JoinedGroup(studyResultId: Long) extends Product with Serializable
Message to a GroupDispatcher.
Message to a GroupDispatcher. The GroupDispatcher will tell all other members of its group about the new member. This msg is NOT responsible for joining a group or opening a new group channel. It merely advises the GroupDispatcher to tell all group members about the newly joined member.
- case class LeftGroup(studyResultId: Long) extends Product with Serializable
Message to a GroupDispatcher.
Message to a GroupDispatcher. The GroupDispatcher will just tell all other members of its GroupResult about the left member. This msg is NOT responsible for leaving a group or closing a group channel. It merely advises the GroupDispatcher to tell all group members about the left member.
- case class PoisonChannel(studyResultId: Long) extends Product with Serializable
Message that forces a GroupChannelActor to close itself.
Message that forces a GroupChannelActor to close itself. Send to a GroupDispatcher it will be forwarded to the right GroupChannelActor.
- case class PoisonEmptyDispatcher() extends Product with Serializable
- case class ReassignChannel(studyResultId: Long, differentGroupDispatcher: ActorRef) extends Product with Serializable
Message to signal that a GroupChannelActor has to change its GroupDispatcher.
Message to signal that a GroupChannelActor has to change its GroupDispatcher. It originates in the GroupChannel service and send to the GroupDispatcher who currently handles the GroupChannelActor. There it is forwarded to the actual GroupChannelActor.
- case class RegisterChannel(studyResultId: Long) extends Product with Serializable
Message a GroupChannelActor can send to register in a GroupDispatcher.
- case class UnregisterChannel(studyResultId: Long) extends Product with Serializable
Message an GroupChannelActor can send to its GroupDispatcher to indicate it's closure.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- object GroupAction extends Enumeration
- object GroupActionJsonKey extends Enumeration
Strings used as keys in the group action JSON
- object TellWhom extends Enumeration