Struct Worker

Source
pub struct Worker<N: Network> { /* private fields */ }
Expand description

A worker’s main role is maintaining a queue of verified (“ready”) transmissions, which will eventually be fetched by the primary when the primary generates a new batch.

Implementations§

Source§

impl<N: Network> Worker<N>

Source

pub fn new( id: u8, gateway: Arc<dyn Transport<N>>, storage: Storage<N>, ledger: Arc<dyn LedgerService<N>>, proposed_batch: Arc<ProposedBatch<N>>, ) -> Result<Self>

Initializes a new worker instance.

Source

pub fn run(&self, receiver: WorkerReceiver<N>)

Run the worker instance.

Source

pub const fn id(&self) -> u8

Returns the worker ID.

Source

pub fn pending(&self) -> &Arc<Pending<TransmissionID<N>, Transmission<N>>>

Returns a reference to the pending transmissions queue.

Source§

impl<N: Network> Worker<N>

Source

pub const MAX_TRANSMISSIONS_PER_WORKER: usize = 50usize

The maximum number of transmissions allowed in a worker.

Source

pub const MAX_TRANSMISSIONS_PER_WORKER_PING: usize = 5usize

The maximum number of transmissions allowed in a worker ping.

Source

pub fn num_transmissions(&self) -> usize

Returns the number of transmissions in the ready queue.

Source

pub fn num_ratifications(&self) -> usize

Returns the number of ratifications in the ready queue.

Source

pub fn num_solutions(&self) -> usize

Returns the number of solutions in the ready queue.

Source

pub fn num_transactions(&self) -> usize

Returns the number of transactions in the ready queue.

Source§

impl<N: Network> Worker<N>

Source

pub fn transmission_ids(&self) -> IndexSet<TransmissionID<N>>

Returns the transmission IDs in the ready queue.

Source

pub fn transmissions(&self) -> IndexMap<TransmissionID<N>, Transmission<N>>

Returns the transmissions in the ready queue.

Source

pub fn solutions( &self, ) -> impl '_ + Iterator<Item = (SolutionID<N>, Data<Solution<N>>)>

Returns the solutions in the ready queue.

Source

pub fn transactions( &self, ) -> impl '_ + Iterator<Item = (N::TransactionID, Data<Transaction<N>>)>

Returns the transactions in the ready queue.

Source§

impl<N: Network> Worker<N>

Source

pub fn contains_transmission( &self, transmission_id: impl Into<TransmissionID<N>>, ) -> bool

Returns true if the transmission ID exists in the ready queue, proposed batch, storage, or ledger.

Source

pub fn get_transmission( &self, transmission_id: TransmissionID<N>, ) -> Option<Transmission<N>>

Returns the transmission if it exists in the ready queue, proposed batch, storage.

Note: We explicitly forbid retrieving a transmission from the ledger, as transmissions in the ledger are not guaranteed to be invalid for the current batch.

Source

pub async fn get_or_fetch_transmission( &self, peer_ip: SocketAddr, transmission_id: TransmissionID<N>, ) -> Result<(TransmissionID<N>, Transmission<N>)>

Returns the transmissions if it exists in the worker, or requests it from the specified peer.

Trait Implementations§

Source§

impl<N: Clone + Network> Clone for Worker<N>

Source§

fn clone(&self) -> Worker<N>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<N> Freeze for Worker<N>

§

impl<N> !RefUnwindSafe for Worker<N>

§

impl<N> Send for Worker<N>

§

impl<N> Sync for Worker<N>

§

impl<N> Unpin for Worker<N>

§

impl<N> !UnwindSafe for Worker<N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,