Struct RetryClient

Source
pub struct RetryClient<T>
where T: JsonRpcProvider, T::Error: Sync + Send + 'static + Debug,
{ /* private fields */ }
Expand description

RetryClient presents as a wrapper around JsonRpcProvider that will retry requests based with an exponential backoff and filtering based on RetryPolicy.

The RetryPolicy, mainly for rate-limiting errors, can be adjusted for specific applications, endpoints. In addition to the RetryPolicy errors due to connectivity issues, like timed out connections or responses in range 5xx can be retried separately.

§Example

use neo3::neo_clients::{HttpProvider, HttpRateLimitRetryPolicy, RetryClientBuilder};
use std::time::Duration;
use url::Url;

async fn demo() {
    let http = HttpProvider::new(Url::parse("http://localhost:8545").unwrap()).unwrap();
    let client = RetryClientBuilder::default()
        .rate_limit_retries(10)
        .timeout_retries(3)
        .initial_backoff(Duration::from_millis(500))
        .build(http, Box::new(HttpRateLimitRetryPolicy::default()));
}

Implementations§

Source§

impl<T> RetryClient<T>
where T: JsonRpcProvider, T::Error: Sync + Send + 'static + Debug,

Source

pub fn new( inner: T, policy: Box<dyn RetryPolicy<T::Error>>, max_retry: u32, initial_backoff: u64, ) -> Self

Creates a new RetryClient that wraps a client and adds retry and backoff support

§Example
use neo3::neo_clients::{HttpProvider, HttpRateLimitRetryPolicy, RetryClient};
use std::time::Duration;
use url::Url;

async fn demo() {
    let http = HttpProvider::new(Url::parse("http://localhost:8545").unwrap()).unwrap();
    let backoff_timeout = 3000; // in ms
    let max_retries = 10;
    let client = RetryClient::new(http, Box::new(HttpRateLimitRetryPolicy::default()), max_retries, backoff_timeout);
}
Source

pub fn set_compute_units(&mut self, cpus: u64) -> &mut Self

Sets the free compute units per second limit.

This is the maximum number of weighted request that can be handled per second by the endpoint before rate limit kicks in.

This is used to guesstimate how long to wait until to retry again

Trait Implementations§

Source§

impl<T> Debug for RetryClient<T>
where T: JsonRpcProvider + Debug, T::Error: Sync + Send + 'static + Debug + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> JsonRpcProvider for RetryClient<T>
where T: JsonRpcProvider + 'static, T::Error: Sync + Send + 'static + Debug,

Source§

type Error = RetryClientError

A JSON-RPC Error
Source§

fn fetch<'life0, 'life1, 'async_trait, A, R>( &'life0 self, method: &'life1 str, params: A, ) -> Pin<Box<dyn Future<Output = Result<R, Self::Error>> + Send + 'async_trait>>
where A: Debug + Serialize + Send + Sync + 'async_trait, R: DeserializeOwned + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a request with the provided JSON-RPC and parameters serialized as JSON

Auto Trait Implementations§

§

impl<T> !Freeze for RetryClient<T>

§

impl<T> !RefUnwindSafe for RetryClient<T>

§

impl<T> Send for RetryClient<T>

§

impl<T> Sync for RetryClient<T>

§

impl<T> Unpin for RetryClient<T>
where T: Unpin,

§

impl<T> !UnwindSafe for RetryClient<T>

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
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
§

impl<T> ErasedDestructor for T
where T: 'static,