Struct architect_sdk::channel_driver::ChannelDriver

pub struct ChannelDriver { /* private fields */ }

Implementations

impl ChannelDriver

pub fn new( subscriber: &Subscriber, channel_path: Path, channel_id: Option<u32> ) -> Self

pub async fn wait_connected(&self) -> Result<()>

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

Close the channel, waiting for all queued messages to send

pub fn path(&self) -> &Path

pub fn user_id(&self) -> Result<UserId>

pub fn with_channel<R>( &self, f: impl FnOnce(&Connection, Address) -> R ) -> Result<R>

Access to the underlying netidx pack_channel connection

pub fn send_to<M>(&self, dst: ComponentId, msg: M) -> Result<()>

where M: Into<TypedMessage>,

pub fn subscribe(&self) -> Receiver<Arc<Vec<Envelope<TypedMessage>>>>

pub async fn wait_until<R>(&self, f: impl FnMut(R) -> bool) -> Result<()>

where TypedMessage: TryInto<MaybeSplit<TypedMessage, R>>,

Wait for a message that satisfies predicate f. The dumber version of [wait_for].

pub async fn wait_for<R, T>(&self, f: impl FnMut(R) -> Option<T>) -> Result<T>

where TypedMessage: TryInto<MaybeSplit<TypedMessage, R>>,

Wait for a response that satisfies f. Ignores and discards any intervening messages.

pub async fn send_to_and_wait_for<M, R, T>( &self, dst: ComponentId, msg: M, f: impl FnMut(R) -> Option<T> ) -> Result<T>

where M: Into<TypedMessage>, TypedMessage: TryInto<MaybeSplit<TypedMessage, R>>,

Send message to a component and wait for a response that satisfies f. Ignores and discards any intervening messages.

pub async fn request_and_wait_for<M, R, T>( &self, dst: ComponentId, msg: M, unwrap: impl Fn(R) -> Result<T> ) -> Result<T>

where M: MaybeRequest + Into<TypedMessage>, R: MaybeRequest, TypedMessage: TryInto<MaybeSplit<TypedMessage, R>>,

Send a request to a component and wait for the corresponding response. Calls the provided unwrap function on the response and returns the result.

Ignores and discards any intervening messages.