Struct tikv::server::gc_worker::AutoGcConfig

pub struct AutoGcConfig<S: GcSafePointProvider, R: RegionInfoProvider> {
    pub safe_point_provider: S,
    pub region_info_provider: R,
    pub self_store_id: u64,
    pub poll_safe_point_interval: Duration,
    pub always_check_safe_point: bool,
    pub post_a_round_of_gc: Option<Box<dyn Fn() + Send>>,
}

The configurations of automatic GC.

Fields

safe_point_provider: S

region_info_provider: R

self_store_id: u64

Used to find which peer of a region is on this TiKV, so that we can compose a Context.

poll_safe_point_interval: Duration

always_check_safe_point: bool

If this is set, safe_point will be checked before doing GC on every region while working. Otherwise safe_point will be only checked when poll_safe_point_interval has past since last checking.

post_a_round_of_gc: Option<Box<dyn Fn() + Send>>

This will be called when a round of GC has finished and goes back to idle state. This field is for test purpose.

Implementations

impl<S: GcSafePointProvider, R: RegionInfoProvider> AutoGcConfig<S, R>

pub fn new(
    safe_point_provider: S,
    region_info_provider: R,
    self_store_id: u64
) -> Self

Creates a new config.

pub fn new_test_cfg(
    safe_point_provider: S,
    region_info_provider: R,
    self_store_id: u64
) -> Self

Creates a config for test purpose. The interval to poll safe point is as short as 0.1s and during GC it never skips checking safe point.