Struct tikv::server::raft_client::RaftClient

[+] Show declaration

pub struct RaftClient<S, R, E> {
    pool: Arc<Mutex<ConnectionPool>>,
    cache: LruCache<(u64, usize), CachedQueue>,
    need_flush: Vec<(u64, usize)>,
    full_stores: Vec<(u64, usize)>,
    future_pool: Arc<ThreadPool<TaskCell>>,
    builder: ConnectionBuilder<S, R>,
    engine: PhantomData<E>,
}

[−] Expand description

A raft client that can manages connections correctly.

A correct usage of raft client is:

for m in msgs {
    if !raft_client.send(m) {
        // handle error.   
    }
}
raft_client.flush();

Fields

pool: Arc<Mutex<ConnectionPool>>

cache: LruCache<(u64, usize), CachedQueue>

need_flush: Vec<(u64, usize)>

full_stores: Vec<(u64, usize)>

future_pool: Arc<ThreadPool<TaskCell>>

builder: ConnectionBuilder<S, R>

engine: PhantomData<E>

Implementations

impl<S, R, E> RaftClient<S, R, E> where
    S: StoreAddrResolver + Send + 'static,
    R: RaftStoreRouter<E> + Unpin + Send + 'static,
    E: KvEngine, [−]

pub fn new(builder: ConnectionBuilder<S, R>) -> RaftClient<S, R, E>

fn load_stream(&mut self, store_id: u64, conn_id: usize) -> bool[−]

Loads connection from pool.

Creates it if it doesn’t exist. false is returned if such connection can’t be established.

pub fn send(&mut self, msg: RaftMessage) -> Result<(), DiscardReason>[−]

Sends a message.

If the message fails to be sent, false is returned. Returning true means the message is enqueued to buffer. Caller is expected to call flush to ensure all buffered messages are sent out.

pub fn need_flush(&self) -> bool

fn flush_full_metrics(&mut self)

pub fn flush(&mut self)[−]

Flushes all buffered messages.

Trait Implementations

impl<S, R, E> Clone for RaftClient<S, R, E> where
    S: Clone,
    R: Clone, [+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

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

Performs copy-assignment from source.