Struct EntryDelivery 

pub struct EntryDelivery<D: DurableRing<Readiness = Event> + Send + 'static> { /* private fields */ }

The Model A front end: owns an instance and hands its entries, one at a time and in queue order, to a handler on thread-pool threads. Derefs to the DeliveryHandle through which the instance’s operations are reached. For an instance whose readiness signal is an Event, which it waits on through the thread pool.

The handler

Called with a DeliveryEvent: each entry, in queue order, and a failure of the instance’s pop when it has one to report, which a handler that ignores is a delivery that stalls without saying so. Called on a pool thread, never twice at once, with the instance’s lock released. It must not panic – a panic unwinds into the thread pool’s callback and aborts the process – and while it runs no further entry is delivered, so a handler that blocks holds up delivery, and holds up into_inner and drop, which wait for it.

Ending

Drop, close and into_inner all quiesce the delivery first: no handler call is running or will start (DI-2.7 point 5), so none runs once they have returned. Drop then drops the instance, and close closes it, each discarding any entry not yet delivered; into_inner hands the instance back with those entries still queued, so it can be popped directly or closed.

Implementations

impl<D: DurableRing<Readiness = Event> + Send + 'static> EntryDelivery<D>

pub fn new<F>( ring: D, on_entry: F, env: Option<&mut CallbackEnviron<'_>>, ) -> Result<Self, DeliverySetupError<D, F>>

where F: FnMut(DeliveryEvent<EntryOf<D>>, &DeliveryHandle<D>) + Send + 'static,

Take ring and deliver its entries to on_entry, on the default thread pool, or on the pool and priority env selects.

Entries already queued when the ring is handed over are delivered: the readiness signal may already have been consumed, so this arms the wait and then sets the signal itself.

Errors

A DeliverySetupError handing back the instance and the handler, when duplicating the readiness signal, creating the thread-pool wait, or setting the signal fails. Only the first is reached by a test: the others fail when the process cannot get another handle or the thread pool cannot create a wait.

pub fn into_inner(self) -> D

Quiesce the delivery and hand back the instance, with any entry not yet delivered still in its queue.

pub fn close(self) -> Leftovers<D::Ids, D::Buffer, D::Context>

Quiesce the delivery and end the instance with DurableRing::close, handing back what is left. Entries not yet delivered are discarded with it.

Methods from Deref<Target = DeliveryHandle<D>>

pub fn add_target( &self, key: IoTargetKey, target: D::Target, ) -> Result<(), AddTargetError<D::Target>>

DurableRing::add_target.

Errors

As DurableRing::add_target.

pub fn remove_target( &self, key: IoTargetKey, ) -> Result<D::Target, RemoveTargetError<D::Ids>>

DurableRing::remove_target.

Errors

As DurableRing::remove_target.

pub fn default_lineage(&self) -> HandleOf<D>

DurableRing::default_lineage.

pub fn mint_lineage(&self, description: Option<String>) -> HandleOf<D>

DurableRing::mint_lineage.

pub fn lineages(&self) -> Vec<LineageInfo<D::Ids>>

DurableRing::lineages.

pub fn end_lineage( &self, handle: HandleOf<D>, ) -> Result<(), EndLineageError<D::Ids>>

DurableRing::end_lineage.

Errors

As DurableRing::end_lineage.

pub fn retire_lineage( &self, handle: HandleOf<D>, ) -> Result<(), RetireLineageError<D::Ids>>

DurableRing::retire_lineage.

Errors

As DurableRing::retire_lineage.

pub fn write( &self, file: IoTargetKey, offset: u64, buffer: D::Buffer, tag: Tag<'_, D::Ids>, context: D::Context, ) -> PushResult<D>

where D::Buffer: IoBuf,

DurableRing::write.

Errors

As DurableRing::write.

pub fn write_with( &self, file: IoTargetKey, offset: u64, buffer: D::Buffer, tag: Tag<'_, D::Ids>, context: D::Context, options: WriteOptions<D::Ids>, ) -> PushResult<D>

where D::Buffer: IoBuf,

DurableRing::write_with.

Errors

As DurableRing::write_with.

pub fn read( &self, file: IoTargetKey, offset: u64, buffer: D::Buffer, context: D::Context, ) -> PushResult<D>

where D::Buffer: IoBufMut,

DurableRing::read.

Errors

As DurableRing::read.

pub fn read_with( &self, file: IoTargetKey, offset: u64, buffer: D::Buffer, context: D::Context, options: ReadOptions<D::Ids>, ) -> PushResult<D>

where D::Buffer: IoBufMut,

DurableRing::read_with.

Errors

As DurableRing::read_with.

pub fn make_durable_through( &self, through: Tag<'_, D::Ids>, ) -> Result<DurabilityRequest<D::Ids>, SealError<D::Ids>>

DurableRing::make_durable_through.

Errors

As DurableRing::make_durable_through.

pub fn durable_through( &self, lineage: Lin<D>, ) -> Result<Option<EpochIdOf<D>>, UnknownLineage<D::Ids>>

DurableRing::durable_through.

Errors

As DurableRing::durable_through.

pub fn sealed_through( &self, lineage: Lin<D>, ) -> Result<Option<EpochIdOf<D>>, UnknownLineage<D::Ids>>

DurableRing::sealed_through.

Errors

As DurableRing::sealed_through.

pub fn epoch_state( &self, epoch: Epoch<D::Ids>, ) -> Result<EpochState<D::Ids>, UnknownLineage<D::Ids>>

DurableRing::epoch_state.

Errors

As DurableRing::epoch_state.

pub fn resolve( &self, items: Vec<(TokenOf<D>, Resolution)>, ) -> Result<(), ResolveError<D::Ids>>

DurableRing::resolve.

Errors

As DurableRing::resolve.

pub fn import_failure( &self, scope: ImportScope<D::Ids>, ) -> Result<Imported<D::Ids>, UnknownLineage<D::Ids>>

DurableRing::import_failure.

Errors

As DurableRing::import_failure.

pub fn failures(&self) -> Vec<FailureInfo<D::Ids>>

DurableRing::failures.

pub fn take_token(&self, failure: FailureIdOf<D>) -> Option<TokenOf<D>>

DurableRing::take_token.

pub fn with_registered_buffer<R>( &self, i: u32, f: impl FnOnce(&[u8]) -> R, ) -> Result<R>

Run f on the bytes of registered buffer i, under the front end’s lock.

Errors

As RegisteredBufferRing::with_registered_buffer.

pub fn with_registered_buffer_mut<R>( &self, i: u32, f: impl FnOnce(&mut [u8]) -> R, ) -> Result<R>

Run f on the bytes of registered buffer i, mutably, under the front end’s lock.

Errors

As RegisteredBufferRing::with_registered_buffer_mut.

pub fn write_registered( &self, file: IoTargetKey, offset: u64, span: RegisteredSpan, tag: Tag<'_, D::Ids>, context: D::Context, ) -> PushResult<D>

RegisteredBufferRing::write_registered.

Errors

As RegisteredBufferRing::write_registered.

pub fn write_registered_with( &self, file: IoTargetKey, offset: u64, span: RegisteredSpan, tag: Tag<'_, D::Ids>, context: D::Context, options: WriteOptions<D::Ids>, ) -> PushResult<D>

RegisteredBufferRing::write_registered_with.

Errors

As RegisteredBufferRing::write_registered_with.

pub fn read_registered( &self, file: IoTargetKey, offset: u64, span: RegisteredSpan, context: D::Context, ) -> PushResult<D>

RegisteredBufferRing::read_registered.

Errors

As RegisteredBufferRing::read_registered.

pub fn read_registered_with( &self, file: IoTargetKey, offset: u64, span: RegisteredSpan, context: D::Context, options: ReadOptions<D::Ids>, ) -> PushResult<D>

RegisteredBufferRing::read_registered_with.

Errors

As RegisteredBufferRing::read_registered_with.

Trait Implementations

impl<D: DurableRing<Readiness = Event> + Send + 'static> Deref for EntryDelivery<D>

type Target = DeliveryHandle<D>

The resulting type after dereferencing.

fn deref(&self) -> &DeliveryHandle<D>

Dereferences the value.

impl<D: DurableRing<Readiness = Event> + Send + 'static> Drop for EntryDelivery<D>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.