Trait twilight_gateway_queue::Queue

pub trait Queue: Debug + Send + Sync {
    fn request<'a>(
        &'a self, 
        shard_id: [u64; 2]
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>>;
}

Queue for shards to request the ability to initialize new sessions with the gateway.

This will usually only need to be implemented when you have a multi-process cluster setup. Refer to the module-level documentation for more information.

Required methods

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

A shard has requested the ability to request a session initialization with the gateway.

The returned future must resolve only when the shard can initiate the session.

Implementors

impl Queue for LargeBotQueue

fn request(
    &self,
    shard_id: [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.

impl Queue for LocalQueue

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.