Package akka.cluster.sharding

Interface Summary

Interface	Description
ClusterShardingSerializable	Marker trait for remote messages and persistent events/snapshots with special serializer.
Shard.EntityState	State machine for an entity:
Shard.RememberEntityCommand	A Shard command
Shard.ShardQuery	A query for information about the shard
Shard.WithRef
ShardCoordinator.ActorSystemDependentAllocationStrategy	Shard allocation strategy where start is called by the shard coordinator before any calls to rebalance or allocate shard.
ShardCoordinator.Internal$.CoordinatorCommand	Messages sent to the coordinator
ShardCoordinator.Internal$.CoordinatorMessage	Messages sent from the coordinator
ShardCoordinator.Internal$.DomainEvent
ShardCoordinator.ShardAllocationStrategy	Interface of the pluggable shard allocation and rebalancing logic used by the ShardCoordinator.
ShardCoordinator.StartableAllocationStrategy	Shard allocation strategy where start is called by the shard coordinator before any calls to rebalance or allocate shard.
ShardingFlightRecorder	INTERNAL API
ShardRegion.MessageExtractor	Java API: Interface of functions to extract entity id, shard id, and the message to send to the entity from an incoming message.
ShardRegion.ShardRegionCommand
ShardRegion.ShardRegionQuery

Class Summary

Class	Description
ClusterSharding
ClusterSharding$	This extension provides sharding functionality of actors in a cluster.
ClusterShardingGuardian	INTERNAL API.
ClusterShardingGuardian.Start
ClusterShardingGuardian.Start$
ClusterShardingGuardian.Started
ClusterShardingGuardian.Started$
ClusterShardingGuardian.StartProxy
ClusterShardingGuardian.StartProxy$
ClusterShardingGuardian$	INTERNAL API.
ClusterShardingHealthCheck	INTERNAL API (ctr)
ClusterShardingHealthCheck$
ClusterShardingHealthCheckSettings
ClusterShardingHealthCheckSettings$	Internal API
ClusterShardingSettings	param: role specifies that this entity type requires cluster nodes with a specific role.
ClusterShardingSettings.TuningParameters
ClusterShardingSettings$
DDataShardCoordinator	INTERNAL API Singleton coordinator (with state based on ddata) that decides where to allocate shards.
DDataShardCoordinator$	INTERNAL API
JoinConfigCompatCheckSharding	INTERNAL API
NoOpShardingFlightRecorder	INTERNAL
NoOpShardingFlightRecorder$	INTERNAL
OldCoordinatorStateMigrationEventAdapter	Used for migrating from persistent state store mode to the new event sourced remember entities.
PersistentShardCoordinator	Deprecated. Use `ddata` mode, persistence mode is deprecated.
RemoveInternalClusterShardingData
RemoveInternalClusterShardingData.RemoveOnePersistenceId	INTERNAL API: Remove all events and snapshots for one specific persistenceId.
RemoveInternalClusterShardingData.RemoveOnePersistenceId$	INTERNAL API
RemoveInternalClusterShardingData.RemoveOnePersistenceId$.Removals
RemoveInternalClusterShardingData.RemoveOnePersistenceId$.Removals$
RemoveInternalClusterShardingData.RemoveOnePersistenceId$.Result
RemoveInternalClusterShardingData.RemoveOnePersistenceId$.Result$
RemoveInternalClusterShardingData$	Utility program that removes the internal data stored with Akka Persistence by the Cluster ShardCoordinator.
Shard	INTERNAL API
Shard.Active
Shard.Active$
Shard.CurrentShardState
Shard.CurrentShardState$
Shard.Entities
Shard.EntitiesMovedToOtherShard	If the shard id extractor is changed, remembered entities will start in a different shard and this message is sent to the shard to not leak entityId -> RememberedButNotStarted entries
Shard.EntitiesMovedToOtherShard$
Shard.GetCurrentShardState$
Shard.GetShardStats$
Shard.LeaseAcquireResult
Shard.LeaseAcquireResult$
Shard.LeaseLost
Shard.LeaseLost$
Shard.LeaseRetry$
Shard.NoState$	Empty state rather than using optionals, is never really kept track of but used to verify state transitions and as return value instead of null
Shard.PassivateIdleTick$
Shard.Passivating
Shard.Passivating$
Shard.RememberedButNotCreated$	In this state we know the entity has been stored in the remember sore but it hasn't been created yet.
Shard.RememberEntityTimeout
Shard.RememberEntityTimeout$
Shard.RememberingStart
Shard.RememberingStart$
Shard.RememberingStop$	When remember entities is enabled an entity is in this state while its stop is being recorded in the remember entities store, or while the stop is queued up to be stored in the next batch.
Shard.RestartTerminatedEntity	When remembering entities and the entity stops without issuing a Passivate, we restart it after a back off using this message.
Shard.RestartTerminatedEntity$
Shard.ShardStats
Shard.ShardStats$
Shard.WaitingForRestart$
Shard$	INTERNAL API
ShardCoordinator	Singleton coordinator that decides where to allocate shards.
ShardCoordinator.AbstractShardAllocationStrategy	Java API: Java implementations of custom shard allocation and rebalancing logic used by the ShardCoordinator should extend this abstract class and implement the two methods.
ShardCoordinator.Internal$	INTERNAL API
ShardCoordinator.LeastShardAllocationStrategy	Use akka.cluster.sharding.ShardCoordinator.ShardAllocationStrategy.leastShardAllocationStrategy instead.
ShardCoordinator.RebalanceWorker	INTERNAL API.
ShardCoordinator.RebalanceWorker$
ShardCoordinator.RebalanceWorker$.ShardRegionTerminated
ShardCoordinator.RebalanceWorker$.ShardRegionTerminated$
ShardCoordinator.ShardAllocationStrategy$
ShardCoordinator$
ShardingFlightRecorder$	INTERNAL API
ShardingLogMarker	This is public with the purpose to document the used markers and properties of log events.
ShardingLogMarker.Properties$	INTERNAL API
ShardingLogMarker$	This is public with the purpose to document the used markers and properties of log events.
ShardingQueries	INTERNAL API
ShardingQueries.ShardsQueryResult<B>	INTERNAL API The result of a group query and metadata.
ShardingQueries.ShardsQueryResult$
ShardingQueries$	INTERNAL API
ShardRegion	INTERNAL API
ShardRegion.ClusterShardingStats	Reply to ShardRegion.GetClusterShardingStats, contains statistics about all the sharding regions in the cluster.
ShardRegion.ClusterShardingStats$
ShardRegion.CurrentRegions	Reply to GetCurrentRegions
ShardRegion.CurrentRegions$
ShardRegion.CurrentShardRegionState	Reply to ShardRegion.GetShardRegionState$
ShardRegion.CurrentShardRegionState$
ShardRegion.GetClusterShardingStats	Send this message to the ShardRegion actor to request for ShardRegion.ClusterShardingStats, which contains statistics about the currently running sharded entities in the entire cluster.
ShardRegion.GetClusterShardingStats$
ShardRegion.GetCurrentRegions$	Send this message to the ShardRegion actor to request for ShardRegion.CurrentRegions, which contains the addresses of all registered regions.
ShardRegion.GetShardRegionState$	Send this message to a ShardRegion actor instance to request a ShardRegion.CurrentShardRegionState which describes the current state of the region.
ShardRegion.GetShardRegionStats$	Send this message to the ShardRegion actor to request for ShardRegion.ShardRegionStats, which contains statistics about the currently running sharded entities in the entire region.
ShardRegion.GetShardRegionStatus$	INTERNAL API
ShardRegion.GracefulShutdown$
ShardRegion.HandOffStopper	INTERNAL API.
ShardRegion.HandOffStopper$	INTERNAL API
ShardRegion.HashCodeMessageExtractor	Convenience implementation of ShardRegion.MessageExtractor that construct shardId based on the hashCode of the entityId.
ShardRegion.HashCodeMessageExtractor$
ShardRegion.Passivate	If the state of the entities are persistent you may stop entities that are not used to reduce memory consumption.
ShardRegion.Passivate$
ShardRegion.ShardInitialized	We must be sure that a shard is initialized before to start send messages to it.
ShardRegion.ShardInitialized$
ShardRegion.ShardRegionStats	param: stats the region stats mapping of ShardId to number of entities param: failed set of shards if any failed to respond within the timeout
ShardRegion.ShardRegionStats$
ShardRegion.ShardRegionStatus	INTERNAL API
ShardRegion.ShardState
ShardRegion.ShardState$
ShardRegion.StartEntity	When remembering entities and a shard is started, each entity id that needs to be running will trigger this message being sent through sharding.
ShardRegion.StartEntity$
ShardRegion.StartEntityAck	Sent back when a ShardRegion.StartEntity message was received and triggered the entity to start (it does not guarantee the entity successfully started)
ShardRegion.StartEntityAck$
ShardRegion$