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
- All
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] to any2stringadd[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] to ArrowAssoc[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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
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] to Ensuring[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] to Ensuring[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] to Ensuring[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] to Ensuring[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: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ShardingMessageExtractor[E, M] to StringFormat[ShardingMessageExtractor[E, M]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (ShardingMessageExtractor[E, M], B)
- Implicit
- This member is added by an implicit conversion from ShardingMessageExtractor[E, M] to ArrowAssoc[ShardingMessageExtractor[E, M]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc