ShardedDaemonProcessId.MessageExtractor

java.lang.Object

org.apache.pekko.cluster.sharding.typed.ShardingMessageExtractor<ShardingEnvelope<T>,T>

org.apache.pekko.cluster.sharding.typed.internal.ShardedDaemonProcessId.MessageExtractor<T>

Enclosing class:: ShardedDaemonProcessId

public static final class ShardedDaemonProcessId.MessageExtractor<T> extends ShardingMessageExtractor<ShardingEnvelope<T>,T>

Constructor Summary

Constructors

Constructor

Description

MessageExtractor()
Method Summary

Modifier and Type

Method

Description

String

entityId(ShardingEnvelope<T> message)

Extract the entity id from an incoming message.

String

shardId(String entityId)

The shard identifier for a given entity id.

T

unwrapMessage(ShardingEnvelope<T> message)

Extract the message to send to the entity from an incoming message.

Methods inherited from class org.apache.pekko.cluster.sharding.typed.ShardingMessageExtractor
apply, noEnvelope

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- MessageExtractor
  
  public MessageExtractor()
Method Details
- entityId
  
  public String entityId(ShardingEnvelope<T> message)
  
  Description copied from class: ShardingMessageExtractor
  
  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
  
  Specified by:
  
  entityId in class ShardingMessageExtractor<ShardingEnvelope<T>,T>
- shardId
  
  public String shardId(String entityId)
  
  Description copied from class: ShardingMessageExtractor
  
  The shard identifier for a given entity id. Only messages that passed the ShardingMessageExtractor.entityId(E) function will be used as input to this function.
  
  Specified by:
  
  shardId in class ShardingMessageExtractor<ShardingEnvelope<T>,T>
- unwrapMessage
  
  public T unwrapMessage(ShardingEnvelope<T> message)
  
  Description copied from class: ShardingMessageExtractor
  
  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.
  
  Specified by:
  
  unwrapMessage in class ShardingMessageExtractor<ShardingEnvelope<T>,T>