hopr-api 1.10.0

Common high-level external and internal API traits used by hopr-lib to implement the HOPR protocol
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

//! Session client operations for establishing HOPR sessions.
//!
//! Gated behind the `node-session-client` feature.

use futures::io::{AsyncRead, AsyncWrite};

use crate::Address;

/// Trait for establishing HOPR sessions to remote destinations.
///
/// The concrete session, configurator, target, and config types are defined
/// by the implementor (typically hopr-lib), keeping transport-level types
/// out of the API crate.
#[async_trait::async_trait]
#[auto_impl::auto_impl(&, Arc)]
pub trait HoprSessionClientOperations: Send + Sync {
    /// An established session implementing async read/write.
    type Session: AsyncRead + AsyncWrite + Send + Unpin;
    /// Handle for controlling a session after creation (e.g. keep-alive, SURB config).
    type SessionConfigurator: Send;
    /// Describes the remote service to connect to.
    type Target: Send;
    /// Configuration for the session (routing, capabilities, etc.).
    type Config: Send;
    /// Error type for session operations.
    type Error: std::error::Error + Send + Sync + 'static;

    /// Establishes a new session to the given `destination` via the HOPR network.
    ///
    /// Returns the session (implementing [`AsyncRead`] + [`AsyncWrite`]) and a configurator
    /// for controlling the session after creation.
    ///
    /// Implementations may retry automatically on failure.
    async fn connect_to(
        &self,
        destination: Address,
        target: Self::Target,
        config: Self::Config,
    ) -> Result<(Self::Session, Self::SessionConfigurator), Self::Error>;
}