Skip to main content

RemoteClient

Struct RemoteClient 

Source
pub struct RemoteClient { /* private fields */ }
Expand description

A remote client that talks to a crafty cluster over any Transport (live QUIC/HTTP/3 in production, the in-memory LocalNetwork in tests).

A client may contact any node: a follower transparently forwards to the leader server-side (client-routing), so a single reachable node is enough. The client is nonetheless configured with several targets and a RetryPolicy so it survives a node being down or an election in flight — it rotates across targets, and follows a NotLeader hint straight to the named leader when one is returned.

Implementations§

Source§

impl RemoteClient

Source

pub fn new( transport: Arc<dyn Transport>, targets: impl IntoIterator<Item = NodeId>, ) -> Self

Build a client over transport that contacts targets (seed node ids; the transport resolves each to an address). Uses the default RetryPolicy.

Source

pub fn with_retry(self, retry: RetryPolicy) -> Self

Override the RetryPolicy.

Source

pub fn targets(&self) -> &[NodeId]

The seed nodes this client rotates across.

Trait Implementations§

Source§

impl Client for RemoteClient

Source§

fn propose( &self, payload: Vec<u8>, ) -> impl Future<Output = Result<Vec<u8>, ClientError>> + Send

Submit a write. payload is the application-encoded command; the returned bytes are the application-encoded response.
Source§

fn query( &self, payload: Vec<u8>, ) -> impl Future<Output = Result<Vec<u8>, ClientError>> + Send

Submit a linearizable read (ReadIndex, read-consistency). payload is the application-encoded query; the returned bytes are the encoded response.
Source§

impl KeyedClient for RemoteClient

Source§

fn propose_keyed( &self, key: Vec<u8>, payload: Vec<u8>, ) -> impl Future<Output = Result<Vec<u8>, ClientError>> + Send

Submit a write to the Raft group owning key.
Source§

fn query_keyed( &self, key: Vec<u8>, payload: Vec<u8>, ) -> impl Future<Output = Result<Vec<u8>, ClientError>> + Send

Submit a linearizable read against the Raft group owning key.
Source§

impl TwoPhaseClient for RemoteClient

Source§

fn prepare_keyed( &self, tx_id: Vec<u8>, key: Vec<u8>, command: Vec<u8>, ) -> impl Future<Output = Result<Vec<u8>, ClientError>> + Send

Stage a command on the shard for key under tx_id.
Source§

fn commit_keyed( &self, tx_id: Vec<u8>, key: Vec<u8>, ) -> impl Future<Output = Result<Vec<u8>, ClientError>> + Send

Commit a previously prepared command.
Source§

fn abort_keyed( &self, tx_id: Vec<u8>, key: Vec<u8>, ) -> impl Future<Output = Result<Vec<u8>, ClientError>> + Send

Abort a prepared command and release staging state.

Auto Trait Implementations§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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