abstract class ShardingMessageExtractor[E, M] extends AnyRef
Entirely customizable typed message extractor. Prefer HashCodeMessageExtractor or HashCodeNoEnvelopeMessageExtractorif possible.
- E
Possibly an Envelope around the messages accepted by the entity actor, is the same as
M
if there is no envelope.- M
The type of message accepted by the entity actor
- Alphabetic
- By Inheritance
- ShardingMessageExtractor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ShardingMessageExtractor()
Abstract Value Members
- abstract def entityId(message: E): String
Extract the entity id from an incoming
message
.Extract the entity id from an incoming
message
. Ifnull
is returned the message will beunhandled
, i.e. posted asUnhandled
messages on the event stream - abstract def shardId(entityId: String): String
The shard identifier for a given entity id.
The shard identifier for a given entity id. Only messages that passed the ShardingMessageExtractor#entityId function will be used as input to this function.
- abstract def unwrapMessage(message: E): M
Extract the message to send to the entity from an incoming
message
.Extract the message to send to the entity from an incoming
message
. Note that the extracted message does not have to be the same as the incoming message to support wrapping in message envelope that is unwrapped before sending to the entity actor.
Concrete 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 ShardingMessageExtractor[E, M] toany2stringadd[ShardingMessageExtractor[E, M]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ShardingMessageExtractor[E, M], B)
- Implicit
- This member is added by an implicit conversion from ShardingMessageExtractor[E, M] toArrowAssoc[ShardingMessageExtractor[E, 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: (ShardingMessageExtractor[E, M]) => Boolean, msg: => Any): ShardingMessageExtractor[E, M]
- Implicit
- This member is added by an implicit conversion from ShardingMessageExtractor[E, M] toEnsuring[ShardingMessageExtractor[E, M]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ShardingMessageExtractor[E, M]) => Boolean): ShardingMessageExtractor[E, M]
- Implicit
- This member is added by an implicit conversion from ShardingMessageExtractor[E, M] toEnsuring[ShardingMessageExtractor[E, M]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ShardingMessageExtractor[E, M]
- Implicit
- This member is added by an implicit conversion from ShardingMessageExtractor[E, M] toEnsuring[ShardingMessageExtractor[E, M]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ShardingMessageExtractor[E, M]
- Implicit
- This member is added by an implicit conversion from ShardingMessageExtractor[E, M] toEnsuring[ShardingMessageExtractor[E, M]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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 ShardingMessageExtractor[E, M] toStringFormat[ShardingMessageExtractor[E, 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): (ShardingMessageExtractor[E, M], B)
- Implicit
- This member is added by an implicit conversion from ShardingMessageExtractor[E, M] toArrowAssoc[ShardingMessageExtractor[E, 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.