tari_comms 5.2.1

A peer-to-peer messaging system
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

// Copyright 2019, The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use tari_shutdown::ShutdownSignal;
use tokio::sync::oneshot;

use crate::{
    connection_manager::{error::ConnectionManagerError, peer_connection::PeerConnection},
    peer_manager::Peer,
};

/// The state of the dial request
pub struct DialState {
    /// Number of dial attempts
    attempts: usize,
    /// This peer being dialed
    peer: Box<Peer>,
    /// Cancel signal
    cancel_signal: ShutdownSignal,
    /// Reply channel for a connection result
    reply_tx: Option<oneshot::Sender<Result<PeerConnection, ConnectionManagerError>>>,
}

impl DialState {
    /// Create a new DialState for the given NodeId
    pub fn new(
        peer: Box<Peer>,
        reply_tx: Option<oneshot::Sender<Result<PeerConnection, ConnectionManagerError>>>,
        cancel_signal: ShutdownSignal,
    ) -> Self {
        Self {
            peer,
            attempts: 0,
            reply_tx,
            cancel_signal,
        }
    }

    /// Take ownership of the cancel receiver if this DialState has ownership of one
    pub fn get_cancel_signal(&self) -> ShutdownSignal {
        self.cancel_signal.clone()
    }

    /// Increment the number of attempts
    pub fn inc_attempts(&mut self) -> &mut Self {
        self.attempts += 1;
        self
    }

    /// The number of attempts
    pub fn num_attempts(&self) -> usize {
        self.attempts
    }

    /// Sends the connection result on the reply channel. If a reply has previously been sent, this is a no-op.
    pub fn send_reply(
        &mut self,
        result: Result<PeerConnection, ConnectionManagerError>,
    ) -> Result<(), Box<Result<PeerConnection, ConnectionManagerError>>> {
        if let Some(reply) = self.reply_tx.take() {
            reply.send(result)?;
            return Ok(());
        }
        Ok(())
    }

    /// Returns a reference to the Peer that is currently being dialed.
    pub fn peer(&self) -> &Peer {
        &self.peer
    }

    pub fn peer_mut(&mut self) -> &mut Peer {
        &mut self.peer
    }
}