darkbio-wire 0.10.0

Encrypted protocol between Ark and host
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

// wire-rs: encrypted protocol between Ark and host
// Copyright 2026 Dark Bio AG. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

//! Handles for closing a session or server from another thread.

use super::{Error, server::ServerInner, session::SessionInner};
use std::sync::Weak;

/// Clonable handle for closing the session or server that created it.
///
/// From [`super::Session::closer`], it closes that session, with the semantics of
/// [`super::Session::close`]. From [`super::Server::closer`], it closes the server
/// and its active session, with the semantics of [`super::Server::close`].
/// Its target never changes: a session's closer cannot affect a successor session.
///
/// This handle does not keep its owner open. Dropping it does not close anything.
#[derive(Clone, Debug)]
pub struct Closer {
    /// Session or server to close.
    target: Target,
}

/// The session or server targeted by a `Closer`.
#[derive(Clone, Debug)]
enum Target {
    /// One session, even after another session connects to the same server.
    Session(Weak<SessionInner>),
    /// One persistent server and whichever session it has attached at closure.
    Server(Weak<ServerInner>),
}

impl Closer {
    /// Closes the original owner. Repeated calls have no further effect.
    pub fn close(&self) {
        match &self.target {
            Target::Session(target) => {
                if let Some(session) = target.upgrade() {
                    session.close(Error::Closed);
                }
            }
            Target::Server(target) => {
                if let Some(server) = target.upgrade() {
                    server.close(Error::Closed);
                }
            }
        }
    }

    /// Creates a closer for one session using a weak reference.
    pub(super) fn session(target: Weak<SessionInner>) -> Self {
        Self {
            target: Target::Session(target),
        }
    }

    /// Creates a closer for one server using a weak reference.
    pub(super) fn server(target: Weak<ServerInner>) -> Self {
        Self {
            target: Target::Server(target),
        }
    }
}

/// Checks that the same closer type works for sessions and servers.
#[cfg(test)]
#[cfg_attr(coverage_nightly, coverage(off))]
mod tests {
    use crate::protocol::{Closer, Server, Session};
    use std::fmt::Debug;

    /// Compiles closing sessions and servers through cloned handles on other threads.
    #[allow(dead_code)]
    fn cross_thread_close(session: &Session, server: &Server) {
        let session_closer: Closer = session.closer();
        let server_closer: Closer = server.closer();
        let session_copy = session_closer.clone();
        let server_copy = server_closer.clone();
        std::thread::spawn(move || session_copy.close());
        std::thread::spawn(move || server_copy.close());
        session.close();
        server.close();
    }

    /// Checks that `Closer` implements `Clone`, `Debug`, `Send`, and `Sync`.
    #[test]
    fn test_thread_capabilities() {
        /// Requires a handle to be clonable, printable and usable by multiple threads.
        fn shared<T: Clone + Debug + Send + Sync + 'static>() {}
        shared::<Closer>();
    }
}