Packages

trait Effector[F[_], S, Alg[_[_]]] extends StateReader[F, S] with Passivator[F] with Self[F, Alg]

Effector represents the ability to read the state of the entity, perform a possible passivation side-effect and further interact with the entity itself via its algebra.

F

context

S

state

Linear Supertypes
Self[F, Alg], Passivator[F], StateReader[F, S], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Effector
  2. Self
  3. Passivator
  4. StateReader
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def disablePassivation: F[Unit]

    Disable scheduled passivation (note that entities automatically recover when receiving a message)

    Disable scheduled passivation (note that entities automatically recover when receiving a message)

    Definition Classes
    Passivator
  2. abstract def enablePassivation(after: FiniteDuration = Duration.Zero): F[Unit]

    Schedule entity passivation after the specified delay - if zero (default), passivate immediately

    Schedule entity passivation after the specified delay - if zero (default), passivate immediately

    after

    delay before passivation

    Definition Classes
    Passivator
  3. abstract def passivationState: F[PassivationState]

    Get the current passivation state

    Get the current passivation state

    Definition Classes
    Passivator
  4. abstract def read: F[Option[S]]

    Read the entity state, returns None if the entity doesn't yet exist

    Read the entity state, returns None if the entity doesn't yet exist

    returns

    optional state in F context

    Definition Classes
    StateReader
  5. abstract def self: Alg[F]
    Definition Classes
    Self

Concrete 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]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def ifKnown(f: (S) => F[Unit])(implicit monad: Monad[F]): F[Unit]
  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
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  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()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Self[F, Alg]

Inherited from Passivator[F]

Inherited from StateReader[F, S]

Inherited from AnyRef

Inherited from Any

Ungrouped