orchestra-toolkit 0.6.1

Client to interract with Orchestra system, uses HGTP 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
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

/* Copyright 2024-2025 LEDR Technologies Inc.
* This file is part of the Orchestra library, which helps developer use our Orchestra technology which is based on AvesTerra, owned and developped by Georgetown University, under license agreement with LEDR Technologies Inc.
*
* The Orchestra library is a free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
*
* The Orchestra library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with the Orchestra library. If not, see <https://www.gnu.org/licenses/>.
*
* If you have any questions, feedback or issues about the Orchestra library, you can contact us at support@ledr.io.
*/

use futures::StreamExt;

use crate::{hgtp::*, SessionConfig};

use super::SessionTrait;

///
/// Asynchronous AvesTerra client
///
/// This is not the recommended client to use. Unless you want to use you own
/// asynchronous context, you should use [`crate::Session`] instead.
/// The [`crate::Session`] client is easier to use, and also provide the ability
/// to execute asynchronous code.
///
/// You need to create the [`SessionAsync`] with [`SessionAsync::initialize`]
///
#[derive(Clone)]
pub struct SessionAsync {
    pub socket_pool: HGTPPool,
}

impl SessionAsync {
    pub async fn initialize(config: SessionConfig) -> anyhow::Result<Self> {
        Ok(Self {
            socket_pool: HGTPPool::new(config).await?,
        })
    }

    /// Cleanly closes all connections.
    /// This method will wait for all currently used connections to be returned
    /// to the pool. This might take a while depending on how long is the queue
    /// of calls waiting for a connection.
    /// In an ideal world this would have been implemented better and the queue
    /// of pending calls would have been cancelled, but it's not the case, sorry.
    pub async fn finalize(&self) {
        let futures = (0..self.socket_pool.state().connections).map(|_| async {
            if let Ok(mut s) = self.socket_pool.get().await {
                s.send_bye().await;
                s.close().await;
            }
        });

        let stream = futures::stream::iter(futures);
        let _: Vec<_> = stream.collect().await;
    }
}

impl SessionTrait for SessionAsync {
    fn get_async_session(&self) -> &SessionAsync {
        self
    }
    fn get_socket_pool(&self) -> &HGTPPool {
        &self.socket_pool
    }
}