Struct pd_client::client::RpcClient

pub struct RpcClient {
    cluster_id: u64,
    pd_client: Arc<Client>,
    monitor: Arc<ThreadPool<TaskCell>>,
}

Fields

cluster_id: u64

pd_client: Arc<Client>

monitor: Arc<ThreadPool<TaskCell>>

Implementations

impl RpcClient

pub fn new(
    cfg: &Config,
    shared_env: Option<Arc<Environment>>,
    security_mgr: Arc<SecurityManager>
) -> Result<RpcClient>

pub async fn new_async(
    cfg: &Config,
    shared_env: Option<Arc<Environment>>,
    security_mgr: Arc<SecurityManager>
) -> Result<RpcClient>

fn header(&self) -> RequestHeader

Creates a new request header.

pub fn get_leader(&self) -> Member

Gets the leader of PD.

pub fn reconnect(&self) -> Result<()>

Re-establishes connection with PD leader in synchronized fashion.

fn call_option(client: &Client) -> CallOption

Creates a new call option with default request timeout.

fn get_region_and_leader(&self, key: &[u8]) -> PdFuture<(Region, Option<Peer>)>

Gets given key’s Region and Region’s leader from PD.

fn get_store_and_stats(&self, store_id: u64) -> PdFuture<(Store, StoreStats)>

Trait Implementations

impl Debug for RpcClient

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PdClient for RpcClient

fn get_cluster_id(&self) -> Result<u64>

Returns the cluster ID.

fn bootstrap_cluster(
    &self,
    stores: Store,
    region: Region
) -> Result<Option<ReplicationStatus>>

Creates the cluster with cluster ID, node, stores and first Region. If the cluster is already bootstrapped, return ClusterBootstrapped error. When a node starts, if it finds nothing in the node and cluster is not bootstrapped, it begins to create node, stores, first Region and then call bootstrap_cluster to let PD know it. It may happen that multi nodes start at same time to try to bootstrap, but only one can succeed, while others will fail and must remove their created local Region data themselves.

fn is_cluster_bootstrapped(&self) -> Result<bool>

Returns whether the cluster is bootstrapped or not.

fn alloc_id(&self) -> Result<u64>

Allocates a unique positive id.

fn put_store(&self, store: Store) -> Result<Option<ReplicationStatus>>

Informs PD when the store starts or some store information changes.

fn get_store(&self, store_id: u64) -> Result<Store>

We don’t need to support Region and Peer put/delete, because PD knows all Region and Peers itself:

fn get_store_async(&self, store_id: u64) -> PdFuture<Store>

Gets store information if it is not a tombstone store asynchronously

fn get_all_stores(&self, exclude_tombstone: bool) -> Result<Vec<Store>>

Gets all stores information.

fn get_cluster_config(&self) -> Result<Cluster>

Gets cluster meta information.

fn get_region(&self, key: &[u8]) -> Result<Region>

For route. Gets Region which the key belongs to.

fn get_region_info(&self, key: &[u8]) -> Result<RegionInfo>

Gets Region info which the key belongs to.

fn get_region_async<'k>(
    &'k self,
    key: &'k [u8]
) -> BoxFuture<'k, Result<Region>>

Gets Region which the key belongs to asynchronously.

fn get_region_info_async<'k>(
    &'k self,
    key: &'k [u8]
) -> BoxFuture<'k, Result<RegionInfo>>

Gets Region info which the key belongs to asynchronously.

fn get_region_by_id(&self, region_id: u64) -> PdFuture<Option<Region>>

Gets Region by Region id.

fn get_region_leader_by_id(
    &self,
    region_id: u64
) -> PdFuture<Option<(Region, Peer)>>

Gets Region and its leader by Region id.

fn region_heartbeat(
    &self,
    term: u64,
    region: Region,
    leader: Peer,
    region_stat: RegionStat,
    replication_status: Option<RegionReplicationStatus>
) -> PdFuture<()>

Region’s Leader uses this to heartbeat PD.

fn handle_region_heartbeat_response<F>(&self, _: u64, f: F) -> PdFuture<()> where
    F: Fn(RegionHeartbeatResponse) + Send + 'static, 

Gets a stream of Region heartbeat response.

fn ask_split(&self, region: Region) -> PdFuture<AskSplitResponse>

Asks PD for split. PD returns the newly split Region id.

fn ask_batch_split(
    &self,
    region: Region,
    count: usize
) -> PdFuture<AskBatchSplitResponse>

Asks PD for batch split. PD returns the newly split Region ids.

fn store_heartbeat(&self, stats: StoreStats) -> PdFuture<StoreHeartbeatResponse>

Sends store statistics regularly.

fn report_batch_split(&self, regions: Vec<Region>) -> PdFuture<()>

Reports PD the split Region.

fn scatter_region(&self, region: RegionInfo) -> Result<()>

Scatters the Region across the cluster.

fn handle_reconnect<F: Fn() + Sync + Send + 'static>(&self, f: F)

Registers a handler to the client, which will be invoked after reconnecting to PD.

fn get_gc_safe_point(&self) -> PdFuture<u64>

fn get_store_stats_async(
    &self,
    store_id: u64
) -> BoxFuture<'_, Result<StoreStats>>

Gets store state if it is not a tombstone store asynchronously.

fn get_operator(&self, region_id: u64) -> Result<GetOperatorResponse>

Gets current operator of the region

fn get_tso(&self) -> PdFuture<TimeStamp>

Gets a timestamp from PD.

fn feature_gate(&self) -> &FeatureGate

Gets the internal FeatureGate.