Struct ibc_relayer::worker::WorkerMap

pub struct WorkerMap { /* private fields */ }

Manage the lifecycle of WorkerHandles associated with Objects.

Implementations

impl WorkerMap

pub fn new() -> Self

Create a new worker map, which will spawn workers with the given channel for sending messages back to the supervisor.

pub fn contains(&self, object: &Object) -> bool

Returns true if there is a spawned WorkerHandle associated with the given Object.

pub fn remove_stopped(&mut self, id: WorkerId, object: Object) -> bool

Remove the WorkerHandle associated with the given Object from the map and wait for its thread to terminate.

pub fn to_notify<'a>(
    &'a self,
    src_chain_id: &'a ChainId
) -> impl Iterator<Item = &'a WorkerHandle>

Returns all the WorkerHandle which are interested in new block events originating from the chain with the given ChainId. See: Object::notify_new_block

pub fn notify_new_block(
    &self,
    src_chain_id: &ChainId,
    height: Height,
    new_block: NewBlock
)

pub fn get_or_spawn<Chain: ChainHandle>(
    &mut self,
    object: Object,
    src: Chain,
    dst: Chain,
    config: &Config
) -> &WorkerHandle

Get a handle to the worker in charge of handling events associated with the given Object.

This function will spawn a new WorkerHandle if one does not exists already.

pub fn spawn<Chain: ChainHandle>(
    &mut self,
    src: Chain,
    dst: Chain,
    object: &Object,
    config: &Config
) -> bool

Spawn a new WorkerHandle, only if one does not exists already.

Returns whether or not the worker was actually spawned.

pub fn objects_for_chain(&self, chain_id: &ChainId) -> Vec<Object>

List the Objects for which there is an associated worker for the given chain.

pub fn workers_for_chain(&self, chain_id: &ChainId) -> Vec<&WorkerHandle>

List the WorkerHandles associated with the given chain.

pub fn handles(&self) -> impl Iterator<Item = &WorkerHandle>

Return all the handles to the workers tracked in this map.

pub fn shutdown_worker(&mut self, object: &Object)

Shutdown the worker associated with the given Object, synchronously.

pub fn shutdown(&mut self)

Shut down all the workers, asynchronously.

Trait Implementations

impl Debug for WorkerMap

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

Formats the value using the given formatter.

impl Default for WorkerMap

fn default() -> Self

Returns the “default value” for a type.

impl Drop for WorkerMap

fn drop(&mut self)

Executes the destructor for this type.