#discord #rate-limiting #discord-api #twilight #sharding

twilight-gateway-queue

Discord Gateway connection queue implementation for the Twilight ecosystem

30 releases (15 breaking)

0.16.0-rc.1 Feb 21, 2024
0.15.4 Sep 10, 2023
0.15.2 Apr 27, 2023
0.15.1 Feb 26, 2023
0.2.1 Nov 10, 2020

#1 in #sharding

Download history 964/week @ 2024-02-26 810/week @ 2024-03-04 892/week @ 2024-03-11 802/week @ 2024-03-18 821/week @ 2024-03-25 1298/week @ 2024-04-01 712/week @ 2024-04-08 885/week @ 2024-04-15 1048/week @ 2024-04-22 928/week @ 2024-04-29 867/week @ 2024-05-06 744/week @ 2024-05-13 828/week @ 2024-05-20 980/week @ 2024-05-27 735/week @ 2024-06-03 691/week @ 2024-06-10

3,304 downloads per month
Used in 11 crates (2 directly)

ISC license

15KB
196 lines

twilight-gateway-queue

codecov badge discord badge github badge license badge rust badge

Rate limiting functionality for gateway IDENTIFY commands.

Discord allows bot's shards to send a limited amount of IDENTIFY commands every 5 seconds, with a daily limit from 1000 to 2000 commands, and invalidates all shard sessions upon exceeding it. Each identify interval may be filled by shards' IDs modulo max_concurrency and such a set of shards is called a bucket. See Discord Docs/Sharding.

To coordinate this, a Queue should process each identify request and shards should wait for its signal to proceed before continuing and otherwise retry. The provided InMemoryQueue never fails or cancels requests and is therefore a good starting point for custom implementations. It can also be composed to support multiple processes; see gateway-queue-http and gateway-queue for a HTTP client and server implementation, respectively.

Dependencies

~2.6–4MB
~70K SLoC