Skip to main content

DhtConfigBuilder

distributed_topic_tracker

Struct DhtConfigBuilder 

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

Builder for DhtConfig.

Implementations§

Source§

impl DhtConfigBuilder

Source

pub fn retries(self, retries: usize) -> Self

Number of retries after the initial attempt.

Total attempts = 1 + retries.

Default: 3.

Examples found in repository?
examples/full_config.rs (line 21)
17fn config_builder() -> Config {
18    Config::builder()
19        .dht_config(
20            DhtConfig::builder()
21                .retries(3)
22                .base_retry_interval(Duration::from_secs(5))
23                .max_retry_jitter(Duration::from_secs(10))
24                .get_timeout(Duration::from_secs(10))
25                .put_timeout(Duration::from_secs(10))
26                .build(),
27        )
28        .bootstrap_config(
29            BootstrapConfig::builder()
30                .max_bootstrap_records(5)
31                .publish_record_on_startup(true)
32                .check_older_records_first_on_startup(false)
33                .discovery_poll_interval(Duration::from_millis(2000))
34                .no_peers_retry_interval(Duration::from_millis(1500))
35                .per_peer_join_settle_time(Duration::from_millis(100))
36                .join_confirmation_wait_time(Duration::from_millis(500))
37                .build(),
38        )
39        .max_join_peer_count(4)
40        .publisher_config(
41            PublisherConfig::builder()
42                .initial_delay(Duration::from_secs(10))
43                .base_interval(Duration::from_secs(10))
44                .max_jitter(Duration::from_secs(50))
45                .build(),
46        )
47        .merge_config(
48            MergeConfig::builder()
49                .bubble_merge(
50                    BubbleMergeConfig::builder()
51                        .min_neighbors(4)
52                        .base_interval(Duration::from_secs(60))
53                        .max_jitter(Duration::from_secs(120))
54                        .fail_topic_creation_on_merge_startup_failure(true)
55                        .build(),
56                )
57                .message_overlap_merge(
58                    MessageOverlapMergeConfig::builder()
59                        .base_interval(Duration::from_secs(60))
60                        .max_jitter(Duration::from_secs(120))
61                        .fail_topic_creation_on_merge_startup_failure(true)
62                        .build(),
63                )
64                .build(),
65        )
66        .timeouts(
67            TimeoutConfig::builder()
68                .join_peer_timeout(Duration::from_secs(5))
69                .broadcast_neighbors_timeout(Duration::from_secs(5))
70                .broadcast_timeout(Duration::from_secs(5))
71                .build(),
72        )
73        .build()
74}
Source

pub fn base_retry_interval(self, interval: Duration) -> Self

Base delay between retries. No-op if interval is Duration::ZERO.

If base_retry_interval is called only once with Duration::ZERO, default value prevails. If base_retry_interval is first called with a > Duration::ZERO, and then again with Duration::ZERO, the first set value is kept.

Default: 5s.

Examples found in repository?
examples/full_config.rs (line 22)
17fn config_builder() -> Config {
18    Config::builder()
19        .dht_config(
20            DhtConfig::builder()
21                .retries(3)
22                .base_retry_interval(Duration::from_secs(5))
23                .max_retry_jitter(Duration::from_secs(10))
24                .get_timeout(Duration::from_secs(10))
25                .put_timeout(Duration::from_secs(10))
26                .build(),
27        )
28        .bootstrap_config(
29            BootstrapConfig::builder()
30                .max_bootstrap_records(5)
31                .publish_record_on_startup(true)
32                .check_older_records_first_on_startup(false)
33                .discovery_poll_interval(Duration::from_millis(2000))
34                .no_peers_retry_interval(Duration::from_millis(1500))
35                .per_peer_join_settle_time(Duration::from_millis(100))
36                .join_confirmation_wait_time(Duration::from_millis(500))
37                .build(),
38        )
39        .max_join_peer_count(4)
40        .publisher_config(
41            PublisherConfig::builder()
42                .initial_delay(Duration::from_secs(10))
43                .base_interval(Duration::from_secs(10))
44                .max_jitter(Duration::from_secs(50))
45                .build(),
46        )
47        .merge_config(
48            MergeConfig::builder()
49                .bubble_merge(
50                    BubbleMergeConfig::builder()
51                        .min_neighbors(4)
52                        .base_interval(Duration::from_secs(60))
53                        .max_jitter(Duration::from_secs(120))
54                        .fail_topic_creation_on_merge_startup_failure(true)
55                        .build(),
56                )
57                .message_overlap_merge(
58                    MessageOverlapMergeConfig::builder()
59                        .base_interval(Duration::from_secs(60))
60                        .max_jitter(Duration::from_secs(120))
61                        .fail_topic_creation_on_merge_startup_failure(true)
62                        .build(),
63                )
64                .build(),
65        )
66        .timeouts(
67            TimeoutConfig::builder()
68                .join_peer_timeout(Duration::from_secs(5))
69                .broadcast_neighbors_timeout(Duration::from_secs(5))
70                .broadcast_timeout(Duration::from_secs(5))
71                .build(),
72        )
73        .build()
74}
Source

pub fn max_retry_jitter(self, jitter: Duration) -> Self

Max random jitter added to retry interval.

Default: 10s.

Examples found in repository?
examples/full_config.rs (line 23)
17fn config_builder() -> Config {
18    Config::builder()
19        .dht_config(
20            DhtConfig::builder()
21                .retries(3)
22                .base_retry_interval(Duration::from_secs(5))
23                .max_retry_jitter(Duration::from_secs(10))
24                .get_timeout(Duration::from_secs(10))
25                .put_timeout(Duration::from_secs(10))
26                .build(),
27        )
28        .bootstrap_config(
29            BootstrapConfig::builder()
30                .max_bootstrap_records(5)
31                .publish_record_on_startup(true)
32                .check_older_records_first_on_startup(false)
33                .discovery_poll_interval(Duration::from_millis(2000))
34                .no_peers_retry_interval(Duration::from_millis(1500))
35                .per_peer_join_settle_time(Duration::from_millis(100))
36                .join_confirmation_wait_time(Duration::from_millis(500))
37                .build(),
38        )
39        .max_join_peer_count(4)
40        .publisher_config(
41            PublisherConfig::builder()
42                .initial_delay(Duration::from_secs(10))
43                .base_interval(Duration::from_secs(10))
44                .max_jitter(Duration::from_secs(50))
45                .build(),
46        )
47        .merge_config(
48            MergeConfig::builder()
49                .bubble_merge(
50                    BubbleMergeConfig::builder()
51                        .min_neighbors(4)
52                        .base_interval(Duration::from_secs(60))
53                        .max_jitter(Duration::from_secs(120))
54                        .fail_topic_creation_on_merge_startup_failure(true)
55                        .build(),
56                )
57                .message_overlap_merge(
58                    MessageOverlapMergeConfig::builder()
59                        .base_interval(Duration::from_secs(60))
60                        .max_jitter(Duration::from_secs(120))
61                        .fail_topic_creation_on_merge_startup_failure(true)
62                        .build(),
63                )
64                .build(),
65        )
66        .timeouts(
67            TimeoutConfig::builder()
68                .join_peer_timeout(Duration::from_secs(5))
69                .broadcast_neighbors_timeout(Duration::from_secs(5))
70                .broadcast_timeout(Duration::from_secs(5))
71                .build(),
72        )
73        .build()
74}
Source

pub fn put_timeout(self, timeout: Duration) -> Self

Timeout for DHT put operations. No-op if timeout is Duration::ZERO.

If put_timeout is called only once with Duration::ZERO, default value prevails. If put_timeout is first called with a > Duration::ZERO, and then again with Duration::ZERO, the first set value is kept.

Default: 10s.

Examples found in repository?
examples/full_config.rs (line 25)
17fn config_builder() -> Config {
18    Config::builder()
19        .dht_config(
20            DhtConfig::builder()
21                .retries(3)
22                .base_retry_interval(Duration::from_secs(5))
23                .max_retry_jitter(Duration::from_secs(10))
24                .get_timeout(Duration::from_secs(10))
25                .put_timeout(Duration::from_secs(10))
26                .build(),
27        )
28        .bootstrap_config(
29            BootstrapConfig::builder()
30                .max_bootstrap_records(5)
31                .publish_record_on_startup(true)
32                .check_older_records_first_on_startup(false)
33                .discovery_poll_interval(Duration::from_millis(2000))
34                .no_peers_retry_interval(Duration::from_millis(1500))
35                .per_peer_join_settle_time(Duration::from_millis(100))
36                .join_confirmation_wait_time(Duration::from_millis(500))
37                .build(),
38        )
39        .max_join_peer_count(4)
40        .publisher_config(
41            PublisherConfig::builder()
42                .initial_delay(Duration::from_secs(10))
43                .base_interval(Duration::from_secs(10))
44                .max_jitter(Duration::from_secs(50))
45                .build(),
46        )
47        .merge_config(
48            MergeConfig::builder()
49                .bubble_merge(
50                    BubbleMergeConfig::builder()
51                        .min_neighbors(4)
52                        .base_interval(Duration::from_secs(60))
53                        .max_jitter(Duration::from_secs(120))
54                        .fail_topic_creation_on_merge_startup_failure(true)
55                        .build(),
56                )
57                .message_overlap_merge(
58                    MessageOverlapMergeConfig::builder()
59                        .base_interval(Duration::from_secs(60))
60                        .max_jitter(Duration::from_secs(120))
61                        .fail_topic_creation_on_merge_startup_failure(true)
62                        .build(),
63                )
64                .build(),
65        )
66        .timeouts(
67            TimeoutConfig::builder()
68                .join_peer_timeout(Duration::from_secs(5))
69                .broadcast_neighbors_timeout(Duration::from_secs(5))
70                .broadcast_timeout(Duration::from_secs(5))
71                .build(),
72        )
73        .build()
74}
Source

pub fn get_timeout(self, timeout: Duration) -> Self

Timeout for DHT get operations. No-op if timeout is Duration::ZERO.

If get_timeout is called only once with Duration::ZERO, default value prevails. If get_timeout is first called with a > Duration::ZERO, and then again with Duration::ZERO, the first set value is kept.

Default: 10s.

Examples found in repository?
examples/full_config.rs (line 24)
17fn config_builder() -> Config {
18    Config::builder()
19        .dht_config(
20            DhtConfig::builder()
21                .retries(3)
22                .base_retry_interval(Duration::from_secs(5))
23                .max_retry_jitter(Duration::from_secs(10))
24                .get_timeout(Duration::from_secs(10))
25                .put_timeout(Duration::from_secs(10))
26                .build(),
27        )
28        .bootstrap_config(
29            BootstrapConfig::builder()
30                .max_bootstrap_records(5)
31                .publish_record_on_startup(true)
32                .check_older_records_first_on_startup(false)
33                .discovery_poll_interval(Duration::from_millis(2000))
34                .no_peers_retry_interval(Duration::from_millis(1500))
35                .per_peer_join_settle_time(Duration::from_millis(100))
36                .join_confirmation_wait_time(Duration::from_millis(500))
37                .build(),
38        )
39        .max_join_peer_count(4)
40        .publisher_config(
41            PublisherConfig::builder()
42                .initial_delay(Duration::from_secs(10))
43                .base_interval(Duration::from_secs(10))
44                .max_jitter(Duration::from_secs(50))
45                .build(),
46        )
47        .merge_config(
48            MergeConfig::builder()
49                .bubble_merge(
50                    BubbleMergeConfig::builder()
51                        .min_neighbors(4)
52                        .base_interval(Duration::from_secs(60))
53                        .max_jitter(Duration::from_secs(120))
54                        .fail_topic_creation_on_merge_startup_failure(true)
55                        .build(),
56                )
57                .message_overlap_merge(
58                    MessageOverlapMergeConfig::builder()
59                        .base_interval(Duration::from_secs(60))
60                        .max_jitter(Duration::from_secs(120))
61                        .fail_topic_creation_on_merge_startup_failure(true)
62                        .build(),
63                )
64                .build(),
65        )
66        .timeouts(
67            TimeoutConfig::builder()
68                .join_peer_timeout(Duration::from_secs(5))
69                .broadcast_neighbors_timeout(Duration::from_secs(5))
70                .broadcast_timeout(Duration::from_secs(5))
71                .build(),
72        )
73        .build()
74}
Source

pub fn build(self) -> DhtConfig

Build the DhtConfig.

Examples found in repository?
examples/full_config.rs (line 26)
17fn config_builder() -> Config {
18    Config::builder()
19        .dht_config(
20            DhtConfig::builder()
21                .retries(3)
22                .base_retry_interval(Duration::from_secs(5))
23                .max_retry_jitter(Duration::from_secs(10))
24                .get_timeout(Duration::from_secs(10))
25                .put_timeout(Duration::from_secs(10))
26                .build(),
27        )
28        .bootstrap_config(
29            BootstrapConfig::builder()
30                .max_bootstrap_records(5)
31                .publish_record_on_startup(true)
32                .check_older_records_first_on_startup(false)
33                .discovery_poll_interval(Duration::from_millis(2000))
34                .no_peers_retry_interval(Duration::from_millis(1500))
35                .per_peer_join_settle_time(Duration::from_millis(100))
36                .join_confirmation_wait_time(Duration::from_millis(500))
37                .build(),
38        )
39        .max_join_peer_count(4)
40        .publisher_config(
41            PublisherConfig::builder()
42                .initial_delay(Duration::from_secs(10))
43                .base_interval(Duration::from_secs(10))
44                .max_jitter(Duration::from_secs(50))
45                .build(),
46        )
47        .merge_config(
48            MergeConfig::builder()
49                .bubble_merge(
50                    BubbleMergeConfig::builder()
51                        .min_neighbors(4)
52                        .base_interval(Duration::from_secs(60))
53                        .max_jitter(Duration::from_secs(120))
54                        .fail_topic_creation_on_merge_startup_failure(true)
55                        .build(),
56                )
57                .message_overlap_merge(
58                    MessageOverlapMergeConfig::builder()
59                        .base_interval(Duration::from_secs(60))
60                        .max_jitter(Duration::from_secs(120))
61                        .fail_topic_creation_on_merge_startup_failure(true)
62                        .build(),
63                )
64                .build(),
65        )
66        .timeouts(
67            TimeoutConfig::builder()
68                .join_peer_timeout(Duration::from_secs(5))
69                .broadcast_neighbors_timeout(Duration::from_secs(5))
70                .broadcast_timeout(Duration::from_secs(5))
71                .build(),
72        )
73        .build()
74}

Trait Implementations§

Source§

impl Clone for DhtConfigBuilder

Source§

fn clone(&self) -> DhtConfigBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DhtConfigBuilder

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

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