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

case class JoinedGroup(studyResultId: Long) extends Product with Serializable

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.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JoinedGroup
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JoinedGroup(studyResultId: Long)

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 finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val studyResultId: Long
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped