tatami 0.1.2

A library for creating satellites and interacting with Tatami protocols.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

use libp2p::{Multiaddr, PeerId};
use std::fmt::Debug;
use tokio::sync::{mpsc, watch};

mod blueprint;
mod launch;
mod message;
mod methods;
mod module;
mod run;
mod utilities;

pub use self::message::Message;
pub use self::message::PeerMessage;
use crate::shoji::ShojiCommand;
use crate::swarm::Swarm;
use crate::Shoji;
pub use blueprint::Blueprint;
pub use module::Module;

#[derive(Debug, Clone)]
pub enum TatamiEvent {
	None,
	ConnectionEstablished(PeerId),
	ConnectionClosed(PeerId),
	UndiagnosedEvent,
	NewListenAddress(Multiaddr),
	MessageReceived(PeerMessage),
}

/// The central struct for running a Tatami Satellite.
/// ```rust
/// use tatami::{Satellite, SatelliteConfig};
///
/// #[tokio::main]
/// async fn main() {
///    let key = Satellite::random_key();
///    let config = SatelliteConfig::default().keypair(key);
///    let satellite = Satellite::launch(config).await.expect("Satellite to be launched");
/// }
/// ```
pub struct Satellite {
	/// A paper-door for interacting with the Satellite asynchronously
	pub shoji: Shoji,
	/// The p2p management supported by libp2p
	swarm: Swarm,
	/// A receiver of Shoji commands
	shoji_command_reciever: mpsc::Receiver<ShojiCommand>,
	/// Sender of various events
	event_sender: watch::Sender<TatamiEvent>,
	/// An event watcher, free to use by modules
	event_watcher: watch::Receiver<TatamiEvent>,
	/// Configuration
	config: Blueprint,
}

impl Debug for Satellite {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		f.debug_struct("Satellite")
			.field("shoji", &self.shoji)
			.field("shoji_command_reciever", &self.shoji_command_reciever)
			.field("event_sender", &self.event_sender)
			.finish()
	}
}