Class/Object

akka.cluster.sharding.typed

ShardingMessageExtractor

Related Docs: object ShardingMessageExtractor | package typed

Permalink

abstract class ShardingMessageExtractor[E, A] 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 A if there is no envelope.

A

The type of message accepted by the entity actor

Source
ShardingMessageExtractor.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
HashCodeMessageExtractor, HashCodeNoEnvelopeMessageExtractor
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. All

Instance Constructors

  1. new ShardingMessageExtractor()

    Permalink

Abstract Value Members

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

    Permalink

    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 handOffStopMessage: A

    Permalink

    Message sent to an entity to tell it to stop, e.g.

    Message sent to an entity to tell it to stop, e.g. when rebalanced. The message defined here is not passed to entityId, shardId or unwrapMessage.

  3. abstract def shardId(entityId: String): String

    Permalink

    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.

  4. abstract def unwrapMessage(message: E): A

    Permalink

    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

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingMessageExtractor[E, A] to any2stringadd[ShardingMessageExtractor[E, A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ShardingMessageExtractor[E, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingMessageExtractor[E, A] to ArrowAssoc[ShardingMessageExtractor[E, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (ShardingMessageExtractor[E, A]) ⇒ Boolean, msg: ⇒ Any): ShardingMessageExtractor[E, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingMessageExtractor[E, A] to Ensuring[ShardingMessageExtractor[E, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (ShardingMessageExtractor[E, A]) ⇒ Boolean): ShardingMessageExtractor[E, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingMessageExtractor[E, A] to Ensuring[ShardingMessageExtractor[E, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): ShardingMessageExtractor[E, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingMessageExtractor[E, A] to Ensuring[ShardingMessageExtractor[E, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): ShardingMessageExtractor[E, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingMessageExtractor[E, A] to Ensuring[ShardingMessageExtractor[E, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingMessageExtractor[E, A] to StringFormat[ShardingMessageExtractor[E, A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. def →[B](y: B): (ShardingMessageExtractor[E, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardingMessageExtractor[E, A] to ArrowAssoc[ShardingMessageExtractor[E, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ShardingMessageExtractor[E, A] to any2stringadd[ShardingMessageExtractor[E, A]]

Inherited by implicit conversion StringFormat from ShardingMessageExtractor[E, A] to StringFormat[ShardingMessageExtractor[E, A]]

Inherited by implicit conversion Ensuring from ShardingMessageExtractor[E, A] to Ensuring[ShardingMessageExtractor[E, A]]

Inherited by implicit conversion ArrowAssoc from ShardingMessageExtractor[E, A] to ArrowAssoc[ShardingMessageExtractor[E, A]]

Ungrouped