Packages

c

akka.cluster.sharding.typed

ShardingEnvelope

final case class ShardingEnvelope[M](entityId: String, message: M) extends WrappedMessage with 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.

entityId

The business domain identifier of the entity.

message

The message to be send to the entity.

Source
ShardingMessageExtractor.scala
Exceptions thrown

`InvalidMessageException` if message is null.

Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardingEnvelope
  2. Serializable
  3. Product
  4. Equals
  5. WrappedMessage
  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: M)

    entityId

    The business domain identifier of the entity.

    message

    The message to be send to the entity.

    Exceptions thrown

    `InvalidMessageException` if message is null.

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
    This member is added by an implicit conversion from ShardingEnvelope[M] toany2stringadd[ShardingEnvelope[M]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ShardingEnvelope[M], B)
    Implicit
    This member is added by an implicit conversion from ShardingEnvelope[M] toArrowAssoc[ShardingEnvelope[M]] 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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (ShardingEnvelope[M]) => Boolean, msg: => Any): ShardingEnvelope[M]
    Implicit
    This member is added by an implicit conversion from ShardingEnvelope[M] toEnsuring[ShardingEnvelope[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ShardingEnvelope[M]) => Boolean): ShardingEnvelope[M]
    Implicit
    This member is added by an implicit conversion from ShardingEnvelope[M] toEnsuring[ShardingEnvelope[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ShardingEnvelope[M]
    Implicit
    This member is added by an implicit conversion from ShardingEnvelope[M] toEnsuring[ShardingEnvelope[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ShardingEnvelope[M]
    Implicit
    This member is added by an implicit conversion from ShardingEnvelope[M] toEnsuring[ShardingEnvelope[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. val entityId: String
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ShardingEnvelope[M] toStringFormat[ShardingEnvelope[M]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val message: M
    Definition Classes
    ShardingEnvelopeWrappedMessage
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (ShardingEnvelope[M], B)
    Implicit
    This member is added by an implicit conversion from ShardingEnvelope[M] toArrowAssoc[ShardingEnvelope[M]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WrappedMessage

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromShardingEnvelope[M] to any2stringadd[ShardingEnvelope[M]]

Inherited by implicit conversion StringFormat fromShardingEnvelope[M] to StringFormat[ShardingEnvelope[M]]

Inherited by implicit conversion Ensuring fromShardingEnvelope[M] to Ensuring[ShardingEnvelope[M]]

Inherited by implicit conversion ArrowAssoc fromShardingEnvelope[M] to ArrowAssoc[ShardingEnvelope[M]]

Ungrouped