Skip to main content

ReplicationEngine

Struct ReplicationEngine 

Source
pub struct ReplicationEngine { /* private fields */ }
Expand description

The replication engine manages all replication background tasks and state.

Implementations§

Source§

impl ReplicationEngine

Source

pub async fn new( config: ReplicationConfig, p2p_node: Arc<P2PNode>, storage: Arc<LmdbStorage>, payment_verifier: Arc<PaymentVerifier>, root_dir: &Path, fresh_write_rx: UnboundedReceiver<FreshWriteEvent>, shutdown: CancellationToken, ) -> Result<Self>

Create a new replication engine.

§Errors

Returns an error if the PaidList LMDB environment cannot be opened or if the configuration fails validation.

Source

pub fn paid_list(&self) -> &Arc<PaidList>

Get a reference to the PaidList.

Source

pub fn start(&mut self, dht_events: Receiver<DhtNetworkEvent>)

Start all background tasks.

dht_events must be subscribed before P2PNode::start() so that the BootstrapComplete event emitted during DHT bootstrap is not missed by the bootstrap-sync gate.

Source

pub async fn is_bootstrapping(&self) -> bool

Returns true if the node is still in the replication bootstrap phase.

During bootstrap, audit challenges return Bootstrapping instead of digests, and neighbor sync responses carry bootstrapping: true.

Source

pub async fn wait_for_bootstrap_complete(&self, timeout: Duration) -> bool

Wait until the replication bootstrap phase completes.

Returns immediately if bootstrap has already completed. Useful for readiness probes, health checks, and test harnesses that need the node to be fully operational before proceeding.

Returns true if bootstrap completed within the timeout, false if the timeout elapsed first.

Source

pub async fn shutdown(&mut self)

Cancel all background tasks and wait for them to terminate.

This must be awaited before dropping the engine when the caller needs the Arc<LmdbStorage> references held by background tasks to be released (e.g. before reopening the same LMDB environment).

Source

pub fn trigger_neighbor_sync(&self)

Trigger an early neighbor sync round.

Useful after topology changes (new nodes joining, network heal after partition) when the caller wants replication to converge faster than the regular 10-20 minute cadence.

Source

pub async fn replicate_fresh( &self, key: &XorName, data: &[u8], proof_of_payment: &[u8], )

Execute fresh replication for a newly stored record.

Auto Trait Implementations§

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> 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> 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, 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