Struct snarkos_network::node::Node[−][src]

pub struct Node<S: Storage>(_);

Expand description

A core data structure for operating the networking stack of this node.

Implementations

impl<S: Storage + Send + Sync + 'static> Node<S>[src]

pub async fn listen(&self) -> Result<(), NetworkError>[src]

This method handles new inbound connection requests.

pub async fn listen_for_inbound_messages(&self, reader: &mut ConnReader)[src]

This method handles new inbound messages from a single connected node.

pub async fn process_incoming_messages(
    &self, 
    receiver: &mut Receiver<Message>, 
    cache: &mut Cache
) -> Result<(), NetworkError>

[src]

pub async fn connection_request(
    &self, 
    own_listener_address: SocketAddr, 
    remote_address: SocketAddr, 
    stream: TcpStream
) -> Result<SocketAddr, NetworkError>

[src]

Handles an incoming connection request, performing a secure handshake and establishing packet encryption.

impl<S: Storage> Node<S>[src]

pub fn state(&self) -> State[src]

Returns the current state of the node.

pub fn set_state(&self, new_state: State)[src]

Changes the current state of the node.

impl<S: Storage + Send + Sync + 'static> Node<S>[src]

pub async fn new(config: Config) -> Result<Self, NetworkError>[src]

Creates a new instance of Node.

pub fn set_sync(&mut self, sync: Sync<S>)[src]

pub fn sync(&self) -> Option<&Arc<Sync<S>>>[src]

Returns a reference to the sync objects.

pub fn expect_sync(&self) -> &Sync<S>[src]

Returns a reference to the sync objects, expecting them to be available.

pub async fn start_services(&self)[src]

pub fn shut_down(&self)[src]

pub fn register_task(&self, handle: JoinHandle<()>)[src]

pub fn register_thread(&self, handle: JoinHandle<()>)[src]

pub fn local_address(&self) -> Option<SocketAddr>[src]

pub fn is_shutting_down(&self) -> bool[src]

pub fn set_local_address(&self, addr: SocketAddr)[src]

Sets the local address of the node to the given value.

pub fn initialize_metrics(&self)[src]

pub fn register_metrics(&self)[src]

impl<S: Storage + Send + Sync + 'static> Node<S>[src]

pub fn send_request(&self, request: Message)[src]

Sends the given request to the address associated with it.

Fetches an existing channel with the remote address, and attempts to send the given request to it.

pub fn send_ping(&self, remote_address: SocketAddr)[src]

pub async fn listen_for_outbound_messages(
    &self, 
    receiver: Receiver<Message>, 
    writer: &mut ConnWriter
)

[src]

This method handles new outbound messages to a single connected node.

impl<S: Storage + Send + Sync + 'static> Node<S>[src]

pub fn disconnect_from_peer(&self, remote_address: SocketAddr)[src]

Removes the given remote address channel and sets the peer in the peer book as disconnected from this node server.

pub fn set_connected(
    &self, 
    remote_address: SocketAddr, 
    remote_listener: SocketAddr, 
    noise: HandshakeState, 
    buffer: Box<[u8]>, 
    reader: OwnedReadHalf, 
    writer: OwnedWriteHalf
) -> Result<(), NetworkError>

[src]

pub fn can_connect(&self) -> bool[src]

impl<S: Storage + Send + Sync + 'static> Node<S>[src]

pub fn update_blocks(&self, sync_node: SocketAddr)[src]

Sends a GetSync request to the given sync node.

pub fn propagate_block(&self, block_bytes: Vec<u8>, block_miner: SocketAddr)[src]

Broadcast block to connected peers

impl<S: Storage + Send + Sync + 'static> Node<S>[src]

pub fn update_memory_pool(&self, sync_node: Option<SocketAddr>)[src]

Triggers the memory pool sync with a selected peer.

impl<S: Storage + Send + Sync + 'static> Node<S>[src]

pub fn is_syncing_blocks(&self) -> bool[src]

Checks whether the node is currently syncing blocks.

pub fn finished_syncing_blocks(&self)[src]

Register that the node is no longer syncing blocks.

pub fn register_block_sync_attempt(&self)[src]

Register that the node attempted to sync blocks.

Methods from Deref<Target = Arc<InnerNode<S>>>

Trait Implementations

impl<S: Storage> Clone for Node<S>[src]

fn clone(&self) -> Self[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl<S: Storage> Deref for Node<S>[src]

type Target = Arc<InnerNode<S>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target[src]

Dereferences the value.

Auto Trait Implementations

impl<S> !RefUnwindSafe for Node<S>

impl<S> Send for Node<S> where
    S: Send + Sync,

impl<S> Sync for Node<S> where
    S: Send + Sync,

impl<S> Unpin for Node<S>

impl<S> !UnwindSafe for Node<S>

Blanket Implementations

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

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T where
    Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
    Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self> where
    Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
    Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
    Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
    Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self> where
    Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
    Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
    Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

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

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

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

[src]

pub fn into(self) -> U[src]

Performs the conversion.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
    R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
    R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
    Self: Borrow<B>,
    B: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
    &'a mut self, 
    func: impl FnOnce(&'a mut B) -> R
) -> R where
    Self: BorrowMut<B>,
    B: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
    Self: AsRef<U>,
    U: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
    Self: AsMut<U>,
    U: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
    Self: Deref<Target = T>,
    T: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
    &'a mut self, 
    func: impl FnOnce(&'a mut T) -> R
) -> R where
    Self: DerefMut<Target = T> + Deref,
    T: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

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

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
    Self: Borrow<B>,
    B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
    Self: BorrowMut<B>,
    B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
    Self: AsRef<R>,
    R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
    Self: AsMut<R>,
    R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
    Self: Deref<Target = T>,
    T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
    Self: DerefMut<Target = T> + Deref,
    T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
    Self: Borrow<B>,
    B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
    Self: BorrowMut<B>,
    B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
    Self: AsRef<R>,
    R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
    Self: AsMut<R>,
    R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
    Self: Deref<Target = T>,
    T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
    Self: DerefMut<Target = T> + Deref,
    T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

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

[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
    Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

[src]

type Error = >::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, >::Error>[src]

Performs the conversion.

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

pub fn vzip(self) -> V