Skip to main content

OutboxDrainer

Struct OutboxDrainer 

Source
pub struct OutboxDrainer<H> { /* private fields */ }
Expand description

Polling drainer delivering entity_outbox rows to a handler.

Implementations§

Source§

impl<H: OutboxHandler> OutboxDrainer<H>

Source

pub fn new(pool: PgPool, handler: H) -> Self

Create a drainer with defaults: batch 32, poll every second, backoff base 5s, 10 attempts.

Source

pub fn batch_size(self, batch_size: i64) -> Self

Set the maximum rows claimed per polling cycle.

Source

pub fn poll_interval(self, poll_interval: Duration) -> Self

Set the sleep between empty polling cycles.

Source

pub fn base_backoff(self, base_backoff: Duration) -> Self

Set the exponential-backoff base delay.

Source

pub fn max_attempts(self, max_attempts: i32) -> Self

Set the retry ceiling before a row is parked.

Source

pub async fn run(self)

Drain continuously until the surrounding task is cancelled.

Source

pub async fn drain_once(&self) -> Result<usize, Error>

Claim and deliver one batch.

Returns the number of rows processed (successfully or scheduled for retry).

§Errors

Propagates database errors from claiming or updating rows.

Auto Trait Implementations§

§

impl<H> !RefUnwindSafe for OutboxDrainer<H>

§

impl<H> !UnwindSafe for OutboxDrainer<H>

§

impl<H> Freeze for OutboxDrainer<H>
where H: Freeze,

§

impl<H> Send for OutboxDrainer<H>
where H: Send,

§

impl<H> Sync for OutboxDrainer<H>
where H: Sync,

§

impl<H> Unpin for OutboxDrainer<H>
where H: Unpin,

§

impl<H> UnsafeUnpin for OutboxDrainer<H>
where H: UnsafeUnpin,

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