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
[[pekko.actor.InvalidMessageException]]
if message is null.
- Alphabetic
- By Inheritance
- ShardingEnvelope
- Serializable
- Product
- Equals
- WrappedMessage
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
[[pekko.actor.InvalidMessageException]]
if message is null.
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 ShardingEnvelope[M] toany2stringadd[ShardingEnvelope[M]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- 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
- 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
- val entityId: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val message: M
- Definition Classes
- ShardingEnvelope → WrappedMessage
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.