Struct Node

pub struct Node<M: DatabaseManager<C>, C: DatabaseCollection> { /* private fields */ }

Structure representing a TAPLE node

A node must be instantiated using the [Taple::build] method, which requires a set of configuration parameters in order to be properly initialized.

Implementations

impl<M: DatabaseManager<C> + 'static, C: DatabaseCollection + 'static> Node<M, C>

pub fn build(settings: Settings, database: M) -> Result<(Self, Api), Error>

This method creates and initializes a TAPLE node.

Possible results

If the process is successful, the method will return Ok(()). An error will be returned only if it has not been possible to generate the necessary data for the initialization of the components, mainly due to problems in the initial configuration.

Panics

This method panics if it has not been possible to generate the network layer.

pub async fn recv_notification(&mut self) -> Option<Notification>

Receive a single notification

All notifications must be consumed. If the notification buffer is full the node will be blocked until there is space in the buffer. Notifications can be consumed in different ways.

recv_notification allows to consume the notifications one by one and keep control of the execution flow.

pub async fn handle_notifications<H>(self, handler: H)

where H: Fn(Notification),

Handle all notifications

All notifications must be consumed. If the notification buffer is full the node will be blocked until there is space in the buffer. Notifications can be consumed in different ways.

handle_notifications processes all notifications from the node. For this purpose, the function in charge of processing the notifications is passed as input. This function blocks the task where it is invoked until the shutdown signal is produced.

pub async fn drop_notifications(self)

Drop all notifications

All notifications must be consumed. If the notification buffer is full the node will be blocked until there is space in the buffer. Notifications can be consumed in different ways.

drop_notifications discards all notifications from the node.

pub fn bind_with_shutdown( &self, signal: impl Future<Output = ()> + Send + 'static, )

Bind the node with a shutdown signal.

When the signal completes, the server will start the graceful shutdown process. The node can be bind to multiple signals.

pub async fn shutdown_gracefully(self)

Shutdown gracefully the node

This function triggers the shutdown signal and waits until the node is safely terminated. This function can only be used if Y or Z has not been used to process the notifications.

Trait Implementations

impl<M: Debug + DatabaseManager<C>, C: Debug + DatabaseCollection> Debug for Node<M, C>

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

Formats the value using the given formatter.