ockam_api 0.49.0

Ockam's request-response API
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

use ockam::identity::Identifier;
use ockam_core::async_trait;
use ockam_core::Result;

use crate::cli_state::NodeInfo;
use crate::config::lookup::InternetAddress;

/// This trait supports the storage of node data:
///
///  - a node has a unique name
///  - a node is always associated to an identifier
///  - a node can be associated to a (single) project
///  - when a node is running we can persist its process id and its TCP listener address
///  - one of the nodes is always set as the default node
///  - a node can be set as an authority node. The purpose of this flag is to be able to display
///    the node status without being able to start a TCP connection since the TCP listener might not be accessible
///
#[async_trait]
pub trait NodesRepository: Send + Sync + 'static {
    /// Store or update the information about a node
    async fn store_node(&self, node_info: &NodeInfo) -> Result<()>;

    /// Get the list of all the nodes
    async fn get_nodes(&self) -> Result<Vec<NodeInfo>>;

    /// Get a node by name
    async fn get_node(&self, node_name: &str) -> Result<Option<NodeInfo>>;

    /// Get the nodes using a given identifier
    async fn get_nodes_by_identifier(&self, identifier: &Identifier) -> Result<Vec<NodeInfo>>;

    /// Get the node set as default
    async fn get_default_node(&self) -> Result<Option<NodeInfo>>;

    /// Set a node set the default node
    async fn set_default_node(&self, node_name: &str) -> Result<()>;

    /// Return true if a node with the given name is the default node
    async fn is_default_node(&self, node_name: &str) -> Result<bool>;

    /// Delete a node given its name
    async fn delete_node(&self, node_name: &str) -> Result<()>;

    /// Set the TCP listener of a node
    async fn set_tcp_listener_address(&self, node_name: &str, address: &str) -> Result<()>;

    /// Set that node as an authority node
    async fn set_as_authority_node(&self, node_name: &str) -> Result<()>;

    /// Get the TCP listener of a node
    async fn get_tcp_listener_address(&self, node_name: &str) -> Result<Option<InternetAddress>>;

    /// Set the process id of a node
    async fn set_node_pid(&self, node_name: &str, pid: u32) -> Result<()>;

    /// Unset the process id of a node
    async fn set_no_node_pid(&self, node_name: &str) -> Result<()>;

    /// Associate a node to a project
    async fn set_node_project_name(&self, node_name: &str, project_name: &str) -> Result<()>;

    /// Return the name of the project associated to a node
    async fn get_node_project_name(&self, node_name: &str) -> Result<Option<String>>;
}