Struct ckb_sync::Synchronizer

source · [−]

pub struct Synchronizer {
    pub shared: Arc<SyncShared>,
    /* private fields */
}

Expand description

Sync protocol handle

Fields

shared: Arc<SyncShared>

Sync shared state

Implementations

source

impl Synchronizer

source

pub fn new(chain: ChainController, shared: Arc<SyncShared>) -> Synchronizer

Init sync protocol handle

This is a runtime sync protocol shared state, and any relay messages will be processed and forwarded by it

source

pub fn shared(&self) -> &Arc<SyncShared>

Get shared state

source

pub fn peers(&self) -> &Peers

Get peers info

source

pub fn process_new_block(&self, block: BlockView) -> Result<bool, CKBError>

Process a new block sync from other peer

source

pub fn get_blocks_to_fetch(
 &self,
 peer: PeerIndex,
 ibd: IBDState
) -> Option<Vec<Vec<Byte32>>>

Get blocks to fetch

source

pub fn eviction(&self, nc: &dyn CKBProtocolContext)

Regularly check and eject some nodes that do not respond in time

Trait Implementations

source

impl CKBProtocolHandler for Synchronizer

source

fn init<'life0, 'async_trait>(
 &'life0 mut self,
 nc: Arc<dyn CKBProtocolContext + Sync>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

Init action on service run

source

fn received<'life0, 'async_trait>(
 &'life0 mut self,
 nc: Arc<dyn CKBProtocolContext + Sync>,
 peer_index: PeerIndex,
 data: Bytes
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

Called when the corresponding protocol message is received

source

fn connected<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 nc: Arc<dyn CKBProtocolContext + Sync>,
 peer_index: PeerIndex,
 _version: &'life1 str
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Called when opening protocol

source

fn disconnected<'life0, 'async_trait>(
 &'life0 mut self,
 _nc: Arc<dyn CKBProtocolContext + Sync>,
 peer_index: PeerIndex
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

Called when closing protocol

source

fn notify<'life0, 'async_trait>(
 &'life0 mut self,
 nc: Arc<dyn CKBProtocolContext + Sync>,
 token: u64
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

Called when the Service receives the notify task

source

fn poll<'life0, 'async_trait>(
 &'life0 mut self,
 _nc: Arc<dyn CKBProtocolContext + Sync + 'static>
) -> Pin<Box<dyn Future<Output = Option<()>> + Send + 'async_trait, Global>> where
 'life0: 'async_trait,
 Self: 'async_trait,

Behave like Stream::poll

source

impl Clone for Synchronizer

source

fn clone(&self) -> Synchronizer

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Synchronizer

impl Send for Synchronizer

impl Sync for Synchronizer

impl Unpin for Synchronizer

impl !UnwindSafe for Synchronizer

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

impl<T> AsAny for T where
T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

TODO(doc): @quake

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

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

source

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

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

Struct ckb_sync::Synchronizer

Fields

Implementations

impl Synchronizer

pub fn new(chain: ChainController, shared: Arc<SyncShared>) -> Synchronizer

pub fn shared(&self) -> &Arc<SyncShared>

pub fn peers(&self) -> &Peers

pub fn process_new_block(&self, block: BlockView) -> Result<bool, CKBError>

pub fn get_blocks_to_fetch( &self, peer: PeerIndex, ibd: IBDState) -> Option<Vec<Vec<Byte32>>>

pub fn eviction(&self, nc: &dyn CKBProtocolContext)

Trait Implementations

impl CKBProtocolHandler for Synchronizer

fn init<'life0, 'async_trait>( &'life0 mut self, nc: Arc<dyn CKBProtocolContext + Sync>) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

fn received<'life0, 'async_trait>( &'life0 mut self, nc: Arc<dyn CKBProtocolContext + Sync>, peer_index: PeerIndex, data: Bytes) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

fn connected<'life0, 'life1, 'async_trait>( &'life0 mut self, nc: Arc<dyn CKBProtocolContext + Sync>, peer_index: PeerIndex, _version: &'life1 str) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn disconnected<'life0, 'async_trait>( &'life0 mut self, _nc: Arc<dyn CKBProtocolContext + Sync>, peer_index: PeerIndex) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

fn notify<'life0, 'async_trait>( &'life0 mut self, nc: Arc<dyn CKBProtocolContext + Sync>, token: u64) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

fn poll<'life0, 'async_trait>( &'life0 mut self, _nc: Arc<dyn CKBProtocolContext + Sync + 'static>) -> Pin<Box<dyn Future<Output = Option<()>> + Send + 'async_trait, Global>> where 'life0: 'async_trait, Self: 'async_trait,

impl Clone for Synchronizer

fn clone(&self) -> Synchronizer

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

Auto Trait Implementations

impl !RefUnwindSafe for Synchronizer

impl Send for Synchronizer

impl Sync for Synchronizer

impl Unpin for Synchronizer

impl !UnwindSafe for Synchronizer

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AsAny for T where T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn get_blocks_to_fetch(
&self,
peer: PeerIndex,
ibd: IBDState
) -> Option<Vec<Vec<Byte32>>>

fn init<'life0, 'async_trait>(
&'life0 mut self,
nc: Arc<dyn CKBProtocolContext + Sync>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

fn received<'life0, 'async_trait>(
&'life0 mut self,
nc: Arc<dyn CKBProtocolContext + Sync>,
peer_index: PeerIndex,
data: Bytes
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

fn connected<'life0, 'life1, 'async_trait>(
&'life0 mut self,
nc: Arc<dyn CKBProtocolContext + Sync>,
peer_index: PeerIndex,
_version: &'life1 str
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn disconnected<'life0, 'async_trait>(
&'life0 mut self,
_nc: Arc<dyn CKBProtocolContext + Sync>,
peer_index: PeerIndex
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

fn notify<'life0, 'async_trait>(
&'life0 mut self,
nc: Arc<dyn CKBProtocolContext + Sync>,
token: u64
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

fn poll<'life0, 'async_trait>(
&'life0 mut self,
_nc: Arc<dyn CKBProtocolContext + Sync + 'static>
) -> Pin<Box<dyn Future<Output = Option<()>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
Self: 'async_trait,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> AsAny for T where
T: Any,

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

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,