Struct ockam_core::flow_control::FlowControls

pub struct FlowControls { /* private fields */ }

Storage for all Flow Control-related data

Implementations

impl FlowControls

pub fn new() -> Self

Constructor

impl FlowControls

pub fn generate_flow_control_id() -> FlowControlId

Generate a fresh random FlowControlId

pub fn add_consumer( &self, address: impl Into<Address>, flow_control_id: &FlowControlId )

Mark that given Address is a Consumer for a Producer with the given FlowControlId

pub fn add_producer( &self, address: impl Into<Address>, flow_control_id: &FlowControlId, spawner_flow_control_id: Option<&FlowControlId>, additional_addresses: Vec<Address> )

Mark that given Address is a Producer for to the given FlowControlId Also, mark that this Producer was spawned by a Spawner with the given spawner FlowControlId (if that’s the case).

pub fn add_spawner( &self, address: impl Into<Address>, flow_control_id: &FlowControlId )

Mark that given Address is a Spawner for to the given FlowControlId

pub fn get_consumers_info( &self, flow_control_id: &FlowControlId ) -> ConsumersInfo

Get known Consumers for the given FlowControlId

pub fn get_flow_control_with_spawner( &self, address: &Address ) -> Option<FlowControlId>

Get FlowControlId for which given Address is a Spawner

pub fn get_flow_control_with_producer( &self, address: &Address ) -> Option<ProducerInfo>

Get ProducerInfo for which given Address is a Producer

pub fn find_flow_control_with_producer_address( &self, address: &Address ) -> Option<ProducerInfo>

Get ProducerInfo for which given Address is a Producer or is an additional Address for that Producer (e.g. Encryptor address for its Decryptor, or TCP Sender for its TCP Receiver)

impl FlowControls

pub fn cleanup_address(&self, address: &Address)

Clean everything that is possible after Address no longer exists

impl FlowControls

pub fn debug_denied_message( &self, source: &Address, source_flow_control_id: &FlowControlId, source_spawner_flow_control_id: &Option<FlowControlId>, destination: &Address )

Prints debug information to investigate why message was not allowed to pass through

Trait Implementations

impl Clone for FlowControls

fn clone(&self) -> FlowControls

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlowControls

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

Formats the value using the given formatter.