ockam_api 0.93.0

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

use std::time::Duration;

use ockam::remote::RemoteRelayInfo;
use ockam_core::{async_trait, Address, Result, Route};

//most sessions replacer are dependent on the node manager, if many session
//fails concurrently, which is the common scenario we need extra time
//to account for the lock contention
pub const MAX_RECOVERY_TIME: Duration = Duration::from_secs(30);
pub const MAX_CONNECT_TIME: Duration = Duration::from_secs(15);

#[async_trait]
pub trait SessionReplacer: Send + Sync + 'static {
    async fn create(&mut self) -> Result<ReplacerOutcome>;

    async fn close(&mut self);

    async fn on_session_down(&self);

    async fn on_session_replaced(&self);
}

#[async_trait]
pub trait AdditionalSessionReplacer: Send + Sync + 'static {
    async fn create_additional(&mut self) -> Result<Route>;
    async fn close_additional(&mut self, enable_fallback: bool);
}

#[derive(Debug, Clone)]
pub struct CurrentInletStatus {
    pub route: Route,
    pub worker: Option<Address>,
}

#[derive(Debug, Clone)]
pub enum ReplacerOutputKind {
    Inlet(CurrentInletStatus),
    Relay(RemoteRelayInfo),
}

#[derive(Debug, Clone)]
pub struct ReplacerOutcome {
    pub ping_route: Route,
    pub kind: ReplacerOutputKind,
}