Class

com.lightbend.lagom.scaladsl.persistence

PersistentEntityRef

Related Doc: package persistence

Permalink

final class PersistentEntityRef[Command] extends NoSerializationVerificationNeeded

Commands are sent to a PersistentEntity using a PersistentEntityRef. It is retrieved with PersistentEntityRegistry#refFor.

Source
PersistentEntityRef.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PersistentEntityRef
  2. NoSerializationVerificationNeeded
  3. AnyRef
  4. 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

Instance Constructors

  1. new PersistentEntityRef(entityId: String, region: ActorRef, system: ActorSystem, askTimeout: FiniteDuration)

    Permalink

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 PersistentEntityRef[Command] to any2stringadd[PersistentEntityRef[Command]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PersistentEntityRef[Command], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentEntityRef[Command] to ArrowAssoc[PersistentEntityRef[Command]] 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 asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def ask[Cmd <: Command with ReplyType[_]](command: Cmd): Future[ask.Cmd.ReplyType]

    Permalink

    Send the command to the PersistentEntity.

    Send the command to the PersistentEntity. The returned Future will be completed with the reply from the PersistentEntity. The type of the reply is defined by the command (see PersistentEntity.ReplyType).

    The Future may also be completed with failure, sent by the PersistentEntity or a akka.pattern.AskTimeoutException if there is no reply within a timeout. The timeout can defined in configuration or overridden using #withAskTimeout.

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ensuring(cond: (PersistentEntityRef[Command]) ⇒ Boolean, msg: ⇒ Any): PersistentEntityRef[Command]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentEntityRef[Command] to Ensuring[PersistentEntityRef[Command]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (PersistentEntityRef[Command]) ⇒ Boolean): PersistentEntityRef[Command]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentEntityRef[Command] to Ensuring[PersistentEntityRef[Command]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): PersistentEntityRef[Command]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentEntityRef[Command] to Ensuring[PersistentEntityRef[Command]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): PersistentEntityRef[Command]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentEntityRef[Command] to Ensuring[PersistentEntityRef[Command]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. val entityId: String

    Permalink
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentEntityRef[Command] to StringFormat[PersistentEntityRef[Command]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

    Permalink
    Definition Classes
    PersistentEntityRef → AnyRef → Any
  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def withAskTimeout(timeout: FiniteDuration): PersistentEntityRef[Command]

    Permalink

    The timeout for #ask.

    The timeout for #ask. The timeout is by default defined in configuration but it can be adjusted for a specific PersistentEntityRef using this method. Note that this returns a new PersistentEntityRef instance with the given timeout (PersistentEntityRef is immutable).

  30. def writeReplace(): AnyRef

    Permalink
    Attributes
    protected
    Annotations
    @throws( ... )
  31. def [B](y: B): (PersistentEntityRef[Command], B)

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PersistentEntityRef[Command] to any2stringadd[PersistentEntityRef[Command]]

Inherited by implicit conversion StringFormat from PersistentEntityRef[Command] to StringFormat[PersistentEntityRef[Command]]

Inherited by implicit conversion Ensuring from PersistentEntityRef[Command] to Ensuring[PersistentEntityRef[Command]]

Inherited by implicit conversion ArrowAssoc from PersistentEntityRef[Command] to ArrowAssoc[PersistentEntityRef[Command]]

Ungrouped