Struct BankWithScheduler

pub struct BankWithScheduler { /* private fields */ }

Very thin wrapper around Arc

It brings type-safety against accidental mixing of bank and scheduler with different slots, which is a pretty dangerous condition. Also, it guarantees to call wait_for_termination() via ::drop() by DropBankService, which receives Vec from BankForks::set_root()’s pruning, mostly matching to Arc’s lifetime by piggybacking on the pruning.

Semantically, a scheduler is tightly coupled with a particular bank. But scheduler wasn’t put into Bank fields to avoid circular-references (a scheduler needs to refer to its accompanied Arc). BankWithScheduler behaves almost like Arc. It only adds a few of transaction scheduling and scheduler management functions. For this reason, bank variable names should be used for BankWithScheduler across codebase.

BankWithScheduler even implements Deref for convenience. And Clone is omitted to implement to avoid ambiguity as to which to clone: BankWithScheduler or Arc. Use clone_without_scheduler() for Arc. Otherwise, use clone_with_scheduler() (this should be unusual outside scheduler code-path)

Implementations

impl BankWithScheduler

pub fn new_without_scheduler(bank: Arc<Bank>) -> Self

pub fn clone_with_scheduler(&self) -> BankWithScheduler

pub fn clone_without_scheduler(&self) -> Arc<Bank>

pub fn register_tick(&self, hash: &Hash)

pub fn has_installed_scheduler(&self) -> bool

pub fn schedule_transaction_executions( &self, transactions_with_indexes: impl ExactSizeIterator<Item = (SanitizedTransaction, usize)>, ) -> Result<()>

Schedule the transaction as long as the scheduler hasn’t been aborted.

If the scheduler has been aborted, this doesn’t schedule the transaction, instead just return the error of prior scheduled transaction.

Calling this will panic if the installed scheduler is Unavailable (the bank is wait_for_termination()-ed or the unified scheduler is disabled in the first place).

pub fn wait_for_completed_scheduler(&self) -> Option<ResultWithTimings>

pub const fn no_scheduler_available() -> InstalledSchedulerRwLock

Trait Implementations

impl Debug for BankWithScheduler

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

Formats the value using the given formatter.

impl Deref for BankWithScheduler

type Target = Arc<Bank>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.