[−][src]Struct serenity::client::bridge::gateway::ShardRunner
A runner for managing a Shard and its respective WebSocket client.
Methods
impl<H: EventHandler + Send + Sync + 'static> ShardRunner<H>[src]
impl<H: EventHandler + Send + Sync + 'static> ShardRunner<H>pub fn new(opt: ShardRunnerOptions<H>) -> Self[src]
pub fn new(opt: ShardRunnerOptions<H>) -> SelfCreates a new runner for a Shard.
pub fn run(&mut self) -> Result<()>[src]
pub fn run(&mut self) -> Result<()>Starts the runner's loop to receive events.
This runs a loop that performs the following in each iteration:
-
checks the receiver for
ShardRunnerMessages, possibly from theShardManager, and if there is one, acts on it. -
checks if a heartbeat should be sent to the discord Gateway, and if so, sends one.
-
attempts to retrieve a message from the WebSocket, processing it into a
GatewayEvent. This will block for 100ms before assuming there is no message available. -
Checks with the
Shardto determine if the gateway event is specifying an action to take (e.g. resuming, reconnecting, heartbeating) and then performs that action, if any. -
Dispatches the event via the Client.
-
Go back to 1.
Auto Trait Implementations
impl<H> Send for ShardRunner<H>
impl<H> Send for ShardRunner<H>impl<H> !Sync for ShardRunner<H>
impl<H> !Sync for ShardRunner<H>Blanket Implementations
impl<T, U> Into for T where
U: From<T>, [src]
impl<T, U> Into for T where
U: From<T>, impl<T> From for T[src]
impl<T> From for Timpl<T, U> TryFrom for T where
T: From<U>, [src]
impl<T, U> TryFrom for T where
T: From<U>, type Error = !
try_from)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>try_from)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized, [src]
impl<T> Borrow for T where
T: ?Sized, impl<T> BorrowMut for T where
T: ?Sized, [src]
impl<T> BorrowMut for T where
T: ?Sized, fn borrow_mut(&mut self) -> &mut T[src]
fn borrow_mut(&mut self) -> &mut TMutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
impl<T, U> TryInto for T where
U: TryFrom<T>, type Error = <U as TryFrom<T>>::Error
try_from)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>try_from)Performs the conversion.
impl<T> Any for T where
T: 'static + ?Sized, [src]
impl<T> Any for T where
T: 'static + ?Sized, fn get_type_id(&self) -> TypeId[src]
fn get_type_id(&self) -> TypeId🔬 This is a nightly-only experimental API. (get_type_id)
this method will likely be replaced by an associated static
Gets the TypeId of self. Read more
impl<T> Erased for T
impl<T> Erased for Timpl<T> Typeable for T where
T: Any,
impl<T> Typeable for T where
T: Any, impl<T> UnsafeAny for T where
T: Any,
impl<T> UnsafeAny for T where
T: Any,