Struct BandwidthControllerRequestSender 

pub struct BandwidthControllerRequestSender { /* private fields */ }

Implementations

impl BandwidthControllerRequestSender

pub fn new(command_tx: UnboundedSender<BandwidthControllerRequest>) -> Self

pub async fn get_ecash_ticket( &self, ticket_type: TicketType, gateway_id: PublicKey, tickets_to_spend: u32, spend_time: OffsetDateTime, ) -> Result<Option<PreparedCredential>, BandwidthControllerError>

pub async fn get_upgrade_mode_token( &self, ) -> Result<Option<String>, BandwidthControllerError>

pub async fn attempt_revert_spending( &self, metadata: PreparedCredentialMetadata, ) -> Result<bool, BandwidthControllerError>

pub async fn set_credential_fetcher( &self, credential_fetcher: Arc<impl CredentialFetcher + 'static>, ) -> Result<(), BandwidthControllerError>

Installs the credential fetcher; the controller immediately restocks any low types.

pub async fn unset_credential_fetcher( &self, ) -> Result<(), BandwidthControllerError>

Removes the credential fetcher; no further automatic restocking happens until one is set.

pub async fn set_public_data_fetcher( &self, public_data_fetcher: Arc<impl CredentialPublicDataFetcher + 'static>, ) -> Result<(), BandwidthControllerError>

Installs the global-data fetcher used to retrieve missing ecash signing materials.

pub async fn unset_public_data_fetcher( &self, ) -> Result<(), BandwidthControllerError>

Removes the global-data fetcher.

pub async fn reset(&self) -> Result<(), BandwidthControllerError>

Cancels in-flight fetches, drops the fetcher, clears stored credentials, and fails any parked readiness waiters. Used to fully de-provision the controller.

pub async fn clear_emergency_credentials( &self, ) -> Result<(), BandwidthControllerError>

Removes stored emergency (upgrade-mode) credentials, leaving ticketbooks intact.

pub async fn get_available_ticketbooks( &self, ) -> Result<AvailableTicketbooks, BandwidthControllerError>

Returns the currently stored ticketbooks.

pub async fn restock_ticketbooks( &self, types: Vec<TicketType>, ) -> Result<(), BandwidthControllerError>

Kicks off a background restock for the given ticket types Returns once the restock is scheduled - it does not wait for the fetches to finish (use Self::wait_for_ticketbooks for that).

Not to be used lightly: the automatic triggers (ticket handout, timer, fetcher install) already keep every type stocked. This is a manual safety valve, not a routine call.

pub async fn restock_all_ticketbooks( &self, ) -> Result<(), BandwidthControllerError>

Kicks off a background restock for every ticket type running low or about to expire. Returns once the restock is scheduled, not once the fetches finish.

pub async fn wait_for_ticketbooks( &self, types: Vec<TicketType>, ) -> Result<(), BandwidthControllerError>

Resolves once every listed type is usable (stocked or covered by upgrade mode). Errors if a required type is neither stocked nor being fetched; otherwise waits while the unsatisfied ones are still in flight.

Trait Implementations

impl BandwidthTicketProvider for BandwidthControllerRequestSender

fn get_ecash_ticket<'life0, 'async_trait>( &'life0 self, ticket_type: TicketType, gateway_id: PublicKey, tickets_to_spend: u32, spend_time: OffsetDateTime, ) -> Pin<Box<dyn Future<Output = Result<Option<PreparedCredential>, BandwidthControllerError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_upgrade_mode_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, BandwidthControllerError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn attempt_revert_spending<'life0, 'async_trait>( &'life0 self, metadata: PreparedCredentialMetadata, ) -> Pin<Box<dyn Future<Output = Result<bool, BandwidthControllerError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn close<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl Clone for BandwidthControllerRequestSender

fn clone(&self) -> BandwidthControllerRequestSender

Returns a duplicate of the value.

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

Performs copy-assignment from source.