Trait/Object

akka.persistence.typed.scaladsl

Effect

Related Docs: object Effect | package scaladsl

Permalink

trait Effect[+Event, State] extends AnyRef

Instances are created through the factories in the Effect companion object.

Not for user extension.

Annotations
@DoNotInherit()
Source
Effect.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
ReplyEffect
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Effect
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def andThen(chainedEffect: SideEffect[State]): Effect[Event, State]

    Permalink

    Run the given callback after the current Effect

  2. abstract def events: Seq[Event]

    Permalink

  3. abstract def thenNoReply(): ReplyEffect[Event, State]

    Permalink

    When PersistentBehavior.withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect.

    When PersistentBehavior.withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. This thenNoReply can be used as a conscious decision that a reply shouldn't be sent for a specific command or the reply will be sent later.

  4. abstract def thenStop(): Effect[Event, State]

    Permalink

    The side effect is to stop the actor

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[Event, State] to any2stringadd[Effect[Event, State]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Effect[Event, State], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[Event, State] to ArrowAssoc[Effect[Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def andThen(chainedEffects: Seq[SideEffect[State]]): Effect[Event, State]

    Permalink

    Run the given callbacks sequentially after the current Effect

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def ensuring(cond: (Effect[Event, State]) ⇒ Boolean, msg: ⇒ Any): Effect[Event, State]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[Event, State] to Ensuring[Effect[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (Effect[Event, State]) ⇒ Boolean): Effect[Event, State]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[Event, State] to Ensuring[Effect[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): Effect[Event, State]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[Event, State] to Ensuring[Effect[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): Effect[Event, State]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[Event, State] to Ensuring[Effect[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[Event, State] to StringFormat[Effect[Event, State]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def thenReply[ReplyMessage](cmd: ExpectingReply[ReplyMessage])(replyWithMessage: (State) ⇒ ReplyMessage): ReplyEffect[Event, State]

    Permalink

    Send a reply message to the command, which implements ExpectingReply.

    Send a reply message to the command, which implements ExpectingReply. The type of the reply message must conform to the type specified in ExpectingReply.replyTo ActorRef.

    This has the same semantics as cmd.replyTo.tell.

    It is provided as a convenience (reducing boilerplate) and a way to enforce that replies are not forgotten when the PersistentBehavior is created with PersistentBehavior.withEnforcedReplies. When withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also if withEnforcedReplies isn't used, but then the compiler will not help finding mistakes.

  25. final def thenRun(callback: (State) ⇒ Unit): Effect[Event, State]

    Permalink

    Run the given callback.

    Run the given callback. Callbacks are run sequentially.

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. def →[B](y: B): (Effect[Event, State], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[Event, State] to ArrowAssoc[Effect[Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Effect[Event, State] to any2stringadd[Effect[Event, State]]

Inherited by implicit conversion StringFormat from Effect[Event, State] to StringFormat[Effect[Event, State]]

Inherited by implicit conversion Ensuring from Effect[Event, State] to Ensuring[Effect[Event, State]]

Inherited by implicit conversion ArrowAssoc from Effect[Event, State] to ArrowAssoc[Effect[Event, State]]

Ungrouped