Packages

c

ackcord.requests

RequestSettings

case class RequestSettings(credentials: Option[HttpCredentials], ratelimiter: Ratelimiter, relativeTime: Boolean = false, parallelism: Int = 4, maxRetryCount: Int = 3, bufferSize: Int = 32, overflowStrategy: OverflowStrategy = OverflowStrategy.backpressure, userAgent: User-Agent = RequestStreams.defaultUserAgent) extends Product with Serializable

credentials

The credentials to use when sending the requests.

ratelimiter

The object to use to track ratelimits and such

relativeTime

Sets if the ratelimit reset should be calculated using relative time instead of absolute time. Might help with out of sync time on your device, but can also lead to slightly slower processing of requests.

parallelism

How many requests to try to process at once.

maxRetryCount

How many times to retry requests if an error occurs on retry flows

bufferSize

The size of the internal buffer used before messages are sent.

overflowStrategy

The strategy to use if the buffer overflows.

Source
RequestSettings.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestSettings
  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 RequestSettings(credentials: Option[HttpCredentials], ratelimiter: Ratelimiter, relativeTime: Boolean = false, parallelism: Int = 4, maxRetryCount: Int = 3, bufferSize: Int = 32, overflowStrategy: OverflowStrategy = OverflowStrategy.backpressure, userAgent: User-Agent = RequestStreams.defaultUserAgent)

    credentials

    The credentials to use when sending the requests.

    ratelimiter

    The object to use to track ratelimits and such

    relativeTime

    Sets if the ratelimit reset should be calculated using relative time instead of absolute time. Might help with out of sync time on your device, but can also lead to slightly slower processing of requests.

    parallelism

    How many requests to try to process at once.

    maxRetryCount

    How many times to retry requests if an error occurs on retry flows

    bufferSize

    The size of the internal buffer used before messages are sent.

    overflowStrategy

    The strategy to use if the buffer overflows.

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 bufferSize: Int
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. val credentials: Option[HttpCredentials]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val maxRetryCount: Int
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. val overflowStrategy: OverflowStrategy
  16. val parallelism: Int
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. val ratelimiter: Ratelimiter
  19. val relativeTime: Boolean
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. val userAgent: User-Agent
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped