Struct glommio::sync::Gate

pub struct Gate { /* fields omitted */ }

Facility to achieve graceful shutdown by waiting for the dependent tasks to complete.

Implementations

impl Gate

pub fn new() -> Self

Create a new Gate

pub fn enter(&self) -> Result<Pass, GlommioError<()>>

Get a visitor pass which will be waited to be released on closing

pub fn spawn<T: 'static>(
    &self,
    future: impl Future<Output = T> + 'static
) -> Result<Task<T>, GlommioError<()>>

Spawn a task for which the gate will wait on closing into the current task queue.

pub fn spawn_into<T: 'static>(
    &self,
    future: impl Future<Output = T> + 'static,
    handle: TaskQueueHandle
) -> Result<Task<T>, GlommioError<()>>

Spawn a task for which the gate will wait on closing

pub async fn close(&self) -> Result<(), GlommioError<()>>

Close the gate, and wait for all spawned tasks to complete

pub fn is_open(&self) -> bool

Whether the gate is open or not

Trait Implementations

impl Clone for Gate

fn clone(&self) -> Gate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gate

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

Formats the value using the given formatter.