case class CacheSettings(processor: CacheProcessor = MemoryCacheSnapshot.defaultCacheProcessor, parallelism: Int = 4, cacheBufferSize: PubSubBufferSize = PubSubBufferSize(), sendGatewayEventsBufferSize: PubSubBufferSize = PubSubBufferSize(), receiveGatewayEventsBufferSize: PubSubBufferSize = PubSubBufferSize(), ignoredEvents: Seq[Class[_ <: GatewayEvent[_]]] = Nil, cacheTypeRegistry: CacheTypeRegistry = CacheTypeRegistry.default, partitionCacheByGuild: Boolean = false) extends Product with Serializable
- processor
A function that runs on the cache right before a cache snapshot is produced.
- parallelism
How many cache updates are constructed in parallel
- cacheBufferSize
Size of the buffer for the cache
- sendGatewayEventsBufferSize
Size of the buffer for sending gateway events
- receiveGatewayEventsBufferSize
Size of the buffer for receiving gateway events
- ignoredEvents
Events the cache will ignore. APIMessage s aren't sent for these either.
- cacheTypeRegistry
Gives you control over how entities in the cache are updated, and what values are retained in the cache.
- partitionCacheByGuild
Instead of sharing a single cache for the entire application, this partitions the cache by guild. Each guild will in effect receive it's own cache. Cache events not specific to one guild will be sent to all caches. Unlike then default cache, this one is faster, as cache updates can be done in parallel, but might use more memory, and you need to handle cross guild cache actions yourself.
- Source
- ClientSettings.scala
- Alphabetic
- By Inheritance
- CacheSettings
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CacheSettings(processor: CacheProcessor = MemoryCacheSnapshot.defaultCacheProcessor, parallelism: Int = 4, cacheBufferSize: PubSubBufferSize = PubSubBufferSize(), sendGatewayEventsBufferSize: PubSubBufferSize = PubSubBufferSize(), receiveGatewayEventsBufferSize: PubSubBufferSize = PubSubBufferSize(), ignoredEvents: Seq[Class[_ <: GatewayEvent[_]]] = Nil, cacheTypeRegistry: CacheTypeRegistry = CacheTypeRegistry.default, partitionCacheByGuild: Boolean = false)
- processor
A function that runs on the cache right before a cache snapshot is produced.
- parallelism
How many cache updates are constructed in parallel
- cacheBufferSize
Size of the buffer for the cache
- sendGatewayEventsBufferSize
Size of the buffer for sending gateway events
- receiveGatewayEventsBufferSize
Size of the buffer for receiving gateway events
- ignoredEvents
Events the cache will ignore. APIMessage s aren't sent for these either.
- cacheTypeRegistry
Gives you control over how entities in the cache are updated, and what values are retained in the cache.
- partitionCacheByGuild
Instead of sharing a single cache for the entire application, this partitions the cache by guild. Each guild will in effect receive it's own cache. Cache events not specific to one guild will be sent to all caches. Unlike then default cache, this one is faster, as cache updates can be done in parallel, but might use more memory, and you need to handle cross guild cache actions yourself.
Value Members
- val cacheBufferSize: PubSubBufferSize
- val cacheTypeRegistry: CacheTypeRegistry
- val ignoredEvents: Seq[Class[_ <: GatewayEvent[_]]]
- val parallelism: Int
- val partitionCacheByGuild: Boolean
- val processor: CacheProcessor
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val receiveGatewayEventsBufferSize: PubSubBufferSize
- val sendGatewayEventsBufferSize: PubSubBufferSize