Struct DistributedMessageSet 

pub struct DistributedMessageSet<S, M> { /* private fields */ }

Implementations

impl<S: Storage, M: DmsMessage> DistributedMessageSet<S, M>

pub async fn fetch( this: Arc<RwLock<Self>>, network_config: &ClientNetworkConfig, ) -> Result<(), Error>

Fetches unknown messages from the peers using an RPC protocol, and adds them to the local storage.

pub async fn broadcast( this: Arc<RwLock<Self>>, network_config: &ClientNetworkConfig, ) -> Result<(), Error>

Tries to broadcast all the message that this DMS instance has.

Note: this function may take just &self due to its simple implementation, but keeps Arc<RwLock<Self>> to make sure the interface to indicate that this is a network-involved method (unlike others)

pub async fn get_peer_status( this: Arc<RwLock<Self>>, network_config: &ClientNetworkConfig, ) -> Result<Vec<PeerStatus>, Error>

impl<S: Storage, M: DmsMessage> DistributedMessageSet<S, M>

pub async fn serve( dms: Arc<RwLock<DistributedMessageSet<S, M>>>, network_config: ServerNetworkConfig, ) -> Result<(), Error>

Runs a DMS server. This function will block the current thread.

pub async fn sync( dms: Arc<RwLock<DistributedMessageSet<S, M>>>, fetch_interval: Option<Duration>, broadcast_interval: Option<Duration>, network_config: ClientNetworkConfig, ) -> Result<(), Error>

Runs a DMS client with auto-sync. This function will block the current thread.

impl<S: Storage, M: DmsMessage> DistributedMessageSet<S, M>

A cumulative set that is shared in the p2p network, backed by the local file system.

One of the notable characteristics of blockchain is that it is based on heights; The key idea here is that we retain an instance (both in memory or on disk) of DistributedMessageSet only for a specific height, and discard it if the height progresses, creating a new and empty one again.

Note that this struct represents only the client side. The server side is implemented in [serve()].

For every method,

• It locks the storage.
• If the given directory is locked (possibly by another instance of DistributedMessageSet), it will await until the lock is released.
• It takes ‘Arc<RwLock>’ instead of self if network clients are used.

TODO: add read only type that does not require the private key.

pub async fn new( storage: S, config: Config, private_key: PrivateKey, ) -> Result<Self, Error>

Creates a message set instance.

If the storage is empty, it creates a new one. If not, check the dms_key with the stored one. It loads the storage if the dms_key is the same. It clears all and initializes a new one if not.

• private_key: The private key for signing messages.

pub fn get_storage(&self) -> Arc<RwLock<S>>

Returns the underlying storage.

This is useful for when you want to store some additional data under the same file lock that this DMS uses.

Note that you MUST NOT create or access files that start with message-.

pub fn get_config(&self) -> Config

pub async fn clear(&mut self) -> Result<(), Error>

pub async fn read_messages(&self) -> Result<Vec<Message<M>>, Error>

Reads the messages from the storage.

pub async fn query_message( &self, message_hash: Hash256, ) -> Result<Option<Message<M>>, Error>

pub async fn commit_message(&mut self, message: &M) -> Result<(), Error>

Signs the given message and adds it to the storage.

pub async fn remove_message( &mut self, message_hash: Hash256, _permanent: Option<String>, ) -> Result<(), Error>

Removes the message from the storage. If permanent is Some with the reason, it permanently rejects the message.

Trait Implementations

impl<S, M> Debug for DistributedMessageSet<S, M>

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

Formats the value using the given formatter.