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

Source
ShardingMessageExtractor.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
HashCodeMessageExtractor, HashCodeNoEnvelopeMessageExtractor, Murmur2MessageExtractor, Murmur2NoEnvelopeMessageExtractor, ShardBySliceMessageExtractor
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardingMessageExtractor
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ShardingMessageExtractor()

Abstract Value Members

  1. abstract def entityId(message: E): String

    Extract the entity id from an incoming message.

    Extract the entity id from an incoming message. If null is returned the message will be unhandled, i.e. posted as Unhandled messages on the event stream

  2. 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.

  3. 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.