Class

akka.cluster.sharding.typed

ShardingEnvelope

Related Doc: package typed

Permalink

final case class ShardingEnvelope[A](entityId: String, message: A) extends Product with Serializable

Default envelope type that may be used with Cluster Sharding.

Cluster Sharding provides a default HashCodeMessageExtractor that is able to handle these types of messages, by hashing the entityId into into the shardId. It is not the only, but a convenient way to send envelope-wrapped messages via cluster sharding.

The alternative way of routing messages through sharding is to not use envelopes, and have the message types themselves carry identifiers.

Source
ShardingMessageExtractor.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardingEnvelope
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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 ShardingEnvelope(entityId: String, message: A)

    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 ShardingEnvelope[A] to any2stringadd[ShardingEnvelope[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ShardingEnvelope[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingEnvelope[A] to ArrowAssoc[ShardingEnvelope[A]] 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 clone(): AnyRef

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

  8. def ensuring(cond: (ShardingEnvelope[A]) ⇒ Boolean, msg: ⇒ Any): ShardingEnvelope[A]

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

  9. def ensuring(cond: (ShardingEnvelope[A]) ⇒ Boolean): ShardingEnvelope[A]

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): ShardingEnvelope[A]

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

  11. def ensuring(cond: Boolean): ShardingEnvelope[A]

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

  12. val entityId: String

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  14. def finalize(): Unit

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

  15. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. val message: A

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  23. final def wait(): Unit

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

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

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

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

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

  26. def →[B](y: B): (ShardingEnvelope[A], B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ShardingEnvelope[A] to any2stringadd[ShardingEnvelope[A]]

Inherited by implicit conversion StringFormat from ShardingEnvelope[A] to StringFormat[ShardingEnvelope[A]]

Inherited by implicit conversion Ensuring from ShardingEnvelope[A] to Ensuring[ShardingEnvelope[A]]

Inherited by implicit conversion ArrowAssoc from ShardingEnvelope[A] to ArrowAssoc[ShardingEnvelope[A]]

Ungrouped