final class PersistentEntityRef[Command] extends NoSerializationVerificationNeeded
Commands are sent to a PersistentEntity using a
PersistentEntityRef. It is retrieved with PersistentEntityRegistry#refFor.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- PersistentEntityRef
- NoSerializationVerificationNeeded
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
- new PersistentEntityRef(entityId: String, region: ActorRef, system: ActorSystem, askTimeout: FiniteDuration)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- 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
-
def
->[B](y: B): (PersistentEntityRef[Command], B)
- Implicit
- 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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
ask[Cmd <: Command with ReplyType[_]](command: Cmd): Future[ask.Cmd.ReplyType]
Send the
commandto the PersistentEntity.Send the
commandto the PersistentEntity. The returnedFuturewill be completed with the reply from thePersistentEntity. The type of the reply is defined by the command (see PersistentEntity.ReplyType).The
Futuremay also be completed with failure, sent by thePersistentEntityor aakka.pattern.AskTimeoutExceptionif there is no reply within a timeout. The timeout can defined in configuration or overridden using #withAskTimeout. -
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ensuring(cond: (PersistentEntityRef[Command]) ⇒ Boolean, msg: ⇒ Any): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: (PersistentEntityRef[Command]) ⇒ Boolean): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: Boolean, msg: ⇒ Any): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: Boolean): PersistentEntityRef[Command]
- Implicit
- 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
- val entityId: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- 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()
-
final
def
getClass(): Class[_]
- 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
- PersistentEntityRef → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withAskTimeout(timeout: FiniteDuration): PersistentEntityRef[Command]
The timeout for #ask.
The timeout for #ask. The timeout is by default defined in configuration but it can be adjusted for a specific
PersistentEntityRefusing this method. Note that this returns a newPersistentEntityRefinstance with the given timeout (PersistentEntityRefis immutable). -
def
writeReplace(): AnyRef
- Attributes
- protected
- Annotations
- @throws( ... )
-
def
→[B](y: B): (PersistentEntityRef[Command], B)
- Implicit
- 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
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
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
Inherited from Any
Inherited by implicit conversion any2stringadd from PersistentEntityRef[Command] to any2stringadd[PersistentEntityRef[Command]]
Value Members
-
def
+(other: String): String
- Implicit
- 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
Inherited by implicit conversion StringFormat from PersistentEntityRef[Command] to StringFormat[PersistentEntityRef[Command]]
Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- 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()
Inherited by implicit conversion Ensuring from PersistentEntityRef[Command] to Ensuring[PersistentEntityRef[Command]]
Value Members
-
def
ensuring(cond: (PersistentEntityRef[Command]) ⇒ Boolean, msg: ⇒ Any): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: (PersistentEntityRef[Command]) ⇒ Boolean): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: Boolean, msg: ⇒ Any): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: Boolean): PersistentEntityRef[Command]
- Implicit
- 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
Inherited by implicit conversion ArrowAssoc from PersistentEntityRef[Command] to ArrowAssoc[PersistentEntityRef[Command]]
Value Members
-
def
->[B](y: B): (PersistentEntityRef[Command], B)
- Implicit
- 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()
-
def
→[B](y: B): (PersistentEntityRef[Command], B)
- Implicit
- 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
Ungrouped
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- 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
-
def
->[B](y: B): (PersistentEntityRef[Command], B)
- Implicit
- 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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
ask[Cmd <: Command with ReplyType[_]](command: Cmd): Future[ask.Cmd.ReplyType]
Send the
commandto the PersistentEntity.Send the
commandto the PersistentEntity. The returnedFuturewill be completed with the reply from thePersistentEntity. The type of the reply is defined by the command (see PersistentEntity.ReplyType).The
Futuremay also be completed with failure, sent by thePersistentEntityor aakka.pattern.AskTimeoutExceptionif there is no reply within a timeout. The timeout can defined in configuration or overridden using #withAskTimeout. -
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ensuring(cond: (PersistentEntityRef[Command]) ⇒ Boolean, msg: ⇒ Any): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: (PersistentEntityRef[Command]) ⇒ Boolean): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: Boolean, msg: ⇒ Any): PersistentEntityRef[Command]
- Implicit
- 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
-
def
ensuring(cond: Boolean): PersistentEntityRef[Command]
- Implicit
- 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
- val entityId: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- 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()
-
final
def
getClass(): Class[_]
- 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
- PersistentEntityRef → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withAskTimeout(timeout: FiniteDuration): PersistentEntityRef[Command]
The timeout for #ask.
The timeout for #ask. The timeout is by default defined in configuration but it can be adjusted for a specific
PersistentEntityRefusing this method. Note that this returns a newPersistentEntityRefinstance with the given timeout (PersistentEntityRefis immutable). -
def
writeReplace(): AnyRef
- Attributes
- protected
- Annotations
- @throws( ... )
-
def
→[B](y: B): (PersistentEntityRef[Command], B)
- Implicit
- 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