Struct CompositeDelegate 

pub struct CompositeDelegate<I, Address, A = VoidDelegate<I, Address>, C = VoidDelegate<I, Address>, E = VoidDelegate<I, Address>, M = VoidDelegate<I, Address>, N = VoidDelegate<I, Address>, P = VoidDelegate<I, Address>> { /* private fields */ }

CompositeDelegate is a helpful struct to split the Delegate into multiple small delegates, so that users do not need to implement full Delegate when they only want to custom some methods in the Delegate.

Implementations

impl<I, Address> CompositeDelegate<I, Address>

pub const fn new() -> Self

Create a new CompositeDelegate

impl<I, Address, A, C, E, M, N, P> CompositeDelegate<I, Address, A, C, E, M, N, P>

pub fn with_alive_delegate<NA>( self, alive_delegate: NA, ) -> CompositeDelegate<I, Address, NA, C, E, M, N, P>

Set the alive delegate

impl<I, Address, A, C, E, M, N, P> CompositeDelegate<I, Address, A, C, E, M, N, P>

pub fn with_conflict_delegate<NC>( self, conflict_delegate: NC, ) -> CompositeDelegate<I, Address, A, NC, E, M, N, P>

Set the conflict delegate

impl<I, Address, A, C, E, M, N, P> CompositeDelegate<I, Address, A, C, E, M, N, P>

pub fn with_event_delegate<NE>( self, event_delegate: NE, ) -> CompositeDelegate<I, Address, A, C, NE, M, N, P>

Set the event delegate

impl<I, Address, A, C, E, M, N, P> CompositeDelegate<I, Address, A, C, E, M, N, P>

pub fn with_merge_delegate<NM>( self, merge_delegate: NM, ) -> CompositeDelegate<I, Address, A, C, E, NM, N, P>

Set the merge delegate

impl<I, Address, A, C, E, M, N, P> CompositeDelegate<I, Address, A, C, E, M, N, P>

pub fn with_node_delegate<NN>( self, node_delegate: NN, ) -> CompositeDelegate<I, Address, A, C, E, M, NN, P>

Set the node delegate

impl<I, Address, A, C, E, M, N, P> CompositeDelegate<I, Address, A, C, E, M, N, P>

pub fn with_ping_delegate<NP>( self, ping_delegate: NP, ) -> CompositeDelegate<I, Address, A, C, E, M, N, NP>

Set the ping delegate

Trait Implementations

impl<I, Address, A, C, E, M, N, P> AliveDelegate for CompositeDelegate<I, Address, A, C, E, M, N, P>

where I: Id + Send + Sync + 'static, Address: CheapClone + Send + Sync + 'static, A: AliveDelegate<Id = I, Address = Address>, C: ConflictDelegate<Id = I, Address = Address>, E: EventDelegate<Id = I, Address = Address>, M: MergeDelegate<Id = I, Address = Address>, N: NodeDelegate, P: PingDelegate<Id = I, Address = Address>,

type Error = <A as AliveDelegate>::Error

The error type of the delegate

type Id = I

The id type of the delegate

type Address = Address

The address type of the delegate

async fn notify_alive( &self, peer: Arc<NodeState<Self::Id, Self::Address>>, ) -> Result<(), Self::Error>

Invoked when a message about a live node is received from the network. Returning a non-nil error prevents the node from being considered a peer.

impl<I, Address, A, C, E, M, N, P> ConflictDelegate for CompositeDelegate<I, Address, A, C, E, M, N, P>

where I: Id + Send + Sync + 'static, Address: CheapClone + Send + Sync + 'static, A: AliveDelegate<Id = I, Address = Address>, C: ConflictDelegate<Id = I, Address = Address>, E: EventDelegate<Id = I, Address = Address>, M: MergeDelegate<Id = I, Address = Address>, N: NodeDelegate, P: PingDelegate<Id = I, Address = Address>,

type Id = I

The id type of the delegate

type Address = Address

The address type of the delegate

async fn notify_conflict( &self, existing: Arc<NodeState<Self::Id, Self::Address>>, other: Arc<NodeState<Self::Id, Self::Address>>, )

Invoked when a name conflict is detected

impl<I, Address> Default for CompositeDelegate<I, Address>

fn default() -> Self

Returns the “default value” for a type.

impl<I, Address, A, C, E, M, N, P> Delegate for CompositeDelegate<I, Address, A, C, E, M, N, P>

where I: Id + Send + Sync + 'static, Address: CheapClone + Send + Sync + 'static, A: AliveDelegate<Id = I, Address = Address>, C: ConflictDelegate<Id = I, Address = Address>, E: EventDelegate<Id = I, Address = Address>, M: MergeDelegate<Id = I, Address = Address>, N: NodeDelegate, P: PingDelegate<Id = I, Address = Address>,

type Address = Address

The address type of the delegate

type Id = I

The id type of the delegate

impl<I, Address, A, C, E, M, N, P> EventDelegate for CompositeDelegate<I, Address, A, C, E, M, N, P>

where I: Id + Send + Sync + 'static, Address: CheapClone + Send + Sync + 'static, A: AliveDelegate<Id = I, Address = Address>, C: ConflictDelegate<Id = I, Address = Address>, E: EventDelegate<Id = I, Address = Address>, M: MergeDelegate<Id = I, Address = Address>, N: NodeDelegate, P: PingDelegate<Id = I, Address = Address>,

type Id = I

The id type of the delegate

type Address = Address

The address type of the delegate

async fn notify_join(&self, node: Arc<NodeState<Self::Id, Self::Address>>)

Invoked when a node is detected to have joined the cluster

async fn notify_leave(&self, node: Arc<NodeState<Self::Id, Self::Address>>)

Invoked when a node is detected to have left the cluster

async fn notify_update(&self, node: Arc<NodeState<Self::Id, Self::Address>>)

Invoked when a node is detected to have updated, usually involving the meta data.

impl<I, Address, A, C, E, M, N, P> MergeDelegate for CompositeDelegate<I, Address, A, C, E, M, N, P>

where I: Id + Send + Sync + 'static, Address: CheapClone + Send + Sync + 'static, A: AliveDelegate<Id = I, Address = Address>, C: ConflictDelegate<Id = I, Address = Address>, E: EventDelegate<Id = I, Address = Address>, M: MergeDelegate<Id = I, Address = Address>, N: NodeDelegate, P: PingDelegate<Id = I, Address = Address>,

type Error = <M as MergeDelegate>::Error

The error type of the delegate

type Id = I

The id type of the delegate

type Address = Address

The address type of the delegate

async fn notify_merge( &self, peers: Arc<[NodeState<Self::Id, Self::Address>]>, ) -> Result<(), Self::Error>

Invoked when a merge could take place. Provides a list of the nodes known by the peer. If the return value is Err, the merge is canceled.

impl<I, Address, A, C, E, M, N, P> NodeDelegate for CompositeDelegate<I, Address, A, C, E, M, N, P>

where I: Id + Send + Sync + 'static, Address: CheapClone + Send + Sync + 'static, A: AliveDelegate<Id = I, Address = Address>, C: ConflictDelegate<Id = I, Address = Address>, E: EventDelegate<Id = I, Address = Address>, M: MergeDelegate<Id = I, Address = Address>, N: NodeDelegate, P: PingDelegate<Id = I, Address = Address>,

async fn node_meta(&self, limit: usize) -> Meta

Used to retrieve meta-data about the current node when broadcasting an alive message. It’s length is limited to the given byte size. This metadata is available in the NodeState structure.

async fn notify_message(&self, msg: Cow<'_, [u8]>)

Called when a user-data message is received. Care should be taken that this method does not block, since doing so would block the entire UDP packet receive loop. Additionally, the byte slice may be modified after the call returns, so it should be copied if needed

async fn broadcast_messages<F>( &self, limit: usize, encoded_len: F, ) -> impl Iterator<Item = Bytes> + Send

where F: Fn(Bytes) -> (usize, Bytes) + Send + Sync + 'static,

Called when user data messages can be broadcast. It can return a list of buffers to send. Each buffer should assume an overhead as provided with a limit on the total byte size allowed. The total byte size of the resulting data to send must not exceed the limit. Care should be taken that this method does not block, since doing so would block the entire UDP packet receive loop.

async fn local_state(&self, join: bool) -> Bytes

Used for a TCP Push/Pull. This is sent to the remote side in addition to the membership information. Any data can be sent here. See merge_remote_state as well. The join boolean indicates this is for a join instead of a push/pull.

async fn merge_remote_state(&self, buf: &[u8], join: bool)

Invoked after a TCP Push/Pull. This is the state received from the remote side and is the result of the remote side’s local_state call. The ‘join’ boolean indicates this is for a join instead of a push/pull.

impl<I, Address, A, C, E, M, N, P> PingDelegate for CompositeDelegate<I, Address, A, C, E, M, N, P>

where I: Id + Send + Sync + 'static, Address: CheapClone + Send + Sync + 'static, A: AliveDelegate<Id = I, Address = Address>, C: ConflictDelegate<Id = I, Address = Address>, E: EventDelegate<Id = I, Address = Address>, M: MergeDelegate<Id = I, Address = Address>, N: NodeDelegate, P: PingDelegate<Id = I, Address = Address>,

type Id = I

The id type of the delegate

type Address = Address

The address type of the delegate

async fn ack_payload(&self) -> Bytes

Invoked when an ack is being sent; the returned bytes will be appended to the ack

async fn notify_ping_complete( &self, node: Arc<NodeState<Self::Id, Self::Address>>, rtt: Duration, payload: Bytes, )

Invoked when an ack for a ping is received

fn disable_reliable_pings(&self, target: &Self::Id) -> bool

Invoked when we want to send a ping message to target by promised connection. Return true if the target node does not expect ping message from promised connection.