Struct twilight_gateway_queue::LocalQueue

pub struct LocalQueue(_);

A local, in-process implementation of a Queue which manages the connection attempts of one or more shards.

The queue will take incoming requests and then queue them, releasing one of the requests every 6 seconds. The queue is necessary because there's a ratelimit on how often shards can initiate sessions.

You usually won't need to handle this yourself, because the Cluster will do that for you when managing multiple shards.

When not to use this

This queue implementation is "local", meaning it's intended to be used if you manage shards only in this process. If you run shards in multiple different processes (do you utilize microservices a lot?), then you must not use this implementation. Shards across multiple processes may create new sessions at the same time, which is bad.

It should also not be used for very large sharding, for that the LargeBotQueue can be used.

If you can't use this, look into an alternative implementation of the Queue, such as the gateway-queue broker.

Implementations

impl LocalQueue

pub fn new() -> Self

Creates a new local queue.

Trait Implementations

impl Clone for LocalQueue

pub fn clone(&self) -> LocalQueue

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LocalQueue

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LocalQueue

pub fn default() -> Self

Returns the "default value" for a type.

impl Queue for LocalQueue

pub fn request(
    &self,
    [id, total]: [u64; 2]
) -> Pin<Box<dyn Future<Output = ()> + Send>>

Request to be able to identify with the gateway. This will place this request behind all other requests, and the returned future will resolve once the request has been completed.