akka.contrib.pattern.ShardRegion

Passivate

Related Doc: package ShardRegion

case class Passivate(stopMessage: Any) extends ShardRegionCommand with Product with Serializable

If the state of the entries are persistent you may stop entries that are not used to reduce memory consumption. This is done by the application specific implementation of the entry actors for example by defining receive timeout (context.setReceiveTimeout). If a message is already enqueued to the entry when it stops itself the enqueued message in the mailbox will be dropped. To support graceful passivation without loosing such messages the entry actor can send this Passivate message to its parent ShardRegion. The specified wrapped stopMessage will be sent back to the entry, which is then supposed to stop itself. Incoming messages will be buffered by the ShardRegion between reception of Passivate and termination of the entry. Such buffered messages are thereafter delivered to a new incarnation of the entry.

akka.actor.PoisonPill is a perfectly fine stopMessage.

Annotations
@SerialVersionUID()
Source
ClusterSharding.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Passivate
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ShardRegionCommand
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Passivate(stopMessage: Any)

Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Passivate to any2stringadd[Passivate] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Passivate, B)

    Implicit information
    This member is added by an implicit conversion from Passivate to ArrowAssoc[Passivate] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from Passivate to Ensuring[Passivate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def finalize(): Unit

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

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

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

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

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. val stopMessage: Any

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

    Definition Classes
    AnyRef
  22. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def [B](y: B): (Passivate, B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ShardRegionCommand

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Passivate to any2stringadd[Passivate]

Inherited by implicit conversion StringFormat from Passivate to StringFormat[Passivate]

Inherited by implicit conversion Ensuring from Passivate to Ensuring[Passivate]

Inherited by implicit conversion ArrowAssoc from Passivate to ArrowAssoc[Passivate]

Ungrouped