Struct cdc::rate_limiter::RateLimiter

pub struct RateLimiter<E> {
    sink: Sender<E>,
    close_tx: AsyncSender<()>,
    state: Arc<State>,
    per_downstream_state: Option<Arc<PerDownstreamState>>,
}

Fields

sink: Sender<E>

close_tx: AsyncSender<()>

state: Arc<State>

per_downstream_state: Option<Arc<PerDownstreamState>>

Implementations

impl<E> RateLimiter<E>

fn new(
    sink: Sender<E>,
    state: Arc<State>,
    close_tx: AsyncSender<()>
) -> RateLimiter<E>

pub fn send_realtime_event(&self, event: E) -> Result<(), RateLimiterError>

send_realtime_event is suitable for sending messages that cannot be delayed. This function is guaranteed to not block the current thread and returns as soon as possible.

pub async fn send_scan_event(&self, event: E) -> Result<(), RateLimiterError>

send_scan_event is used to send an event from incremental scan. Note that this function is async and may block.

pub fn start_flush(&self)

tells the drainer to flush the underlying sink. It is NOT guaranteed that the drainer will consume all data inside the RateLimiter, but only that the underlying rpc sink will be flushed at least once after the call.

Since we do not use a timer in the drainer, make sure that for any rpc connection, this function is called periodically.

pub fn with_region_id(self, region_id: u64) -> RateLimiter<E>

pub fn close_with_error(&self, event: E) -> Result<(), RateLimiterError>

Trait Implementations

impl<E> Clone for RateLimiter<E>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E> Drop for RateLimiter<E>

fn drop(&mut self)

Executes the destructor for this type.