c

ackcord

CacheSettings

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: (Logger) => 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. APIMessages 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
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CacheSettings
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CacheSettings(processor: CacheProcessor = MemoryCacheSnapshot.defaultCacheProcessor, parallelism: Int = 4, cacheBufferSize: PubSubBufferSize = PubSubBufferSize(), sendGatewayEventsBufferSize: PubSubBufferSize = PubSubBufferSize(), receiveGatewayEventsBufferSize: PubSubBufferSize = PubSubBufferSize(), ignoredEvents: Seq[Class[_ <: GatewayEvent[_]]] = Nil, cacheTypeRegistry: (Logger) => 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. APIMessages 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val cacheBufferSize: PubSubBufferSize
  6. val cacheTypeRegistry: (Logger) => CacheTypeRegistry
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. val ignoredEvents: Seq[Class[_ <: GatewayEvent[_]]]
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. val parallelism: Int
  17. val partitionCacheByGuild: Boolean
  18. val processor: CacheProcessor
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val receiveGatewayEventsBufferSize: PubSubBufferSize
  21. val sendGatewayEventsBufferSize: PubSubBufferSize
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped