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

//! Session server trait for processing incoming HOPR sessions.
//!
//! Gated behind the `node-session-server` feature.

/// Trait for processing incoming HOPR sessions on exit nodes.
///
/// The concrete session type is defined by the implementor (typically hopr-lib),
/// keeping transport-level types out of the API crate.
///
/// Nodes that do not run a session server simply omit calling `with_session_server`.
#[async_trait::async_trait]
#[auto_impl::auto_impl(Arc)]
pub trait HoprSessionServer {
    /// An incoming session to be processed.
    type Session: Send;
    /// Error type for session processing.
    type Error: std::error::Error + Send + Sync + 'static;

    /// Fully process a single incoming HOPR session.
    async fn process(&self, session: Self::Session) -> Result<(), Self::Error>;
}