discord4j.core.shard

Interface InvalidationStrategy

public interface InvalidationStrategy

A contract to determine how a Store invalidation should happen on a shard session terminating. Use one of the following factories to create a strategy:

• Disable any shard store invalidation using disable()
• Do not provide any additional behavior using identity(). Recommended for single shard configurations
• Perform shard invalidation using a JDK registry using withJdkRegistry()
• Perform shard invalidation using a custom registry using withCustomRegistry(KeyStoreRegistry)

Method Summary

Modifier and Type	Method and Description
StoreService	adaptStoreService(StoreService storeService) Obtain a transformed StoreService that is capable of supporting this invalidation strategy.
static discord4j.core.shard.NoInvalidationStrategy	disable() Create an InvalidationStrategy that disables any action on shard invalidation.
static discord4j.core.shard.IdentityInvalidationStrategy	identity() Create an InvalidationStrategy that falls through the underlying Store.invalidate() implementation to invalidate entries on shard session closing.
Mono<Void>	invalidate(ShardInfo shardInfo, StateHolder stateHolder) Invalidate the contents of the given StateHolder depending on the triggering shard.
static discord4j.core.shard.KeyStoreInvalidationStrategy	withCustomRegistry(KeyStoreRegistry keyStoreRegistry) Create an InvalidationStrategy that uses a custom KeyStoreRegistry to keep track of stored keys and invalidate them on shard session closing.
static discord4j.core.shard.KeyStoreInvalidationStrategy	withJdkRegistry() Create an InvalidationStrategy that uses a JdkKeyStoreRegistry to keep track of stored keys and invalidate them on shard session closing.

Method Detail

adaptStoreService

StoreService adaptStoreService(StoreService storeService)

Obtain a transformed StoreService that is capable of supporting this invalidation strategy.

Parameters:

storeService - the original configured StoreService

Returns:

a new StoreService that can run this strategy

invalidate

Mono<Void> invalidate(ShardInfo shardInfo,
                      StateHolder stateHolder)

Invalidate the contents of the given StateHolder depending on the triggering shard.

Parameters:

shardInfo - the shard that triggered this invalidation

stateHolder - the entity with access to all Store instances used by this strategy

Returns:

a Mono

disable

static discord4j.core.shard.NoInvalidationStrategy disable()

Create an InvalidationStrategy that disables any action on shard invalidation.

Returns:

a NoInvalidationStrategy

identity

static discord4j.core.shard.IdentityInvalidationStrategy identity()

Create an InvalidationStrategy that falls through the underlying Store.invalidate() implementation to invalidate entries on shard session closing.

Returns:

a IdentityInvalidationStrategy

withJdkRegistry

static discord4j.core.shard.KeyStoreInvalidationStrategy withJdkRegistry()

Create an InvalidationStrategy that uses a JdkKeyStoreRegistry to keep track of stored keys and invalidate them on shard session closing. This enables up-to-date cached entities at the cost of additional memory footprint.

Returns:

a KeyStoreInvalidationStrategy using a JDK based registry

withCustomRegistry

static discord4j.core.shard.KeyStoreInvalidationStrategy withCustomRegistry(KeyStoreRegistry keyStoreRegistry)

Create an InvalidationStrategy that uses a custom KeyStoreRegistry to keep track of stored keys and invalidate them on shard session closing.

Parameters:

keyStoreRegistry - the registry used to store keys

Returns:

a KeyStoreInvalidationStrategy using a custom registry