splinter 0.6.14

Splinter is a privacy-focused platform for distributed applications that provides a blockchain-inspired networking environment for communication and transactions between organizations.
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
95
96
97

// Copyright 2018-2022 Cargill Incorporated
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Data structures for building a `PeerManager` instance.
//!
//! The public interface includes the structs [`PeerRef`] and [`EndpointPeerRef`]

use super::PeerTokenPair;
use crate::peer::connector::PeerRemover;

/// Used to keep track of peer references. When dropped, the `PeerRef` will send a request to the
/// `PeerManager` to remove a reference to the peer, thus removing the peer if no more references
/// exist.
#[derive(Debug, PartialEq)]
pub struct PeerRef {
    peer_id: PeerTokenPair,
    peer_remover: PeerRemover,
}

impl PeerRef {
    /// Creates a new `PeerRef`
    pub(super) fn new(peer_id: PeerTokenPair, peer_remover: PeerRemover) -> Self {
        PeerRef {
            peer_id,
            peer_remover,
        }
    }

    /// Returns the peer ID this reference is for
    pub fn peer_id(&self) -> &PeerTokenPair {
        &self.peer_id
    }
}

impl Drop for PeerRef {
    fn drop(&mut self) {
        match self.peer_remover.remove_peer_ref(&self.peer_id) {
            Ok(_) => (),
            Err(err) => error!(
                "Unable to remove reference to {} on drop: {}",
                self.peer_id, err
            ),
        }
    }
}

/// Used to keep track of peer references that are created only with an endpoint. When dropped, a
/// request is sent to the `PeerManager` to remove a reference to the peer, thus removing the peer
/// if no more references exist.
#[derive(Debug, PartialEq)]
pub struct EndpointPeerRef {
    endpoint: String,
    connection_id: String,
    peer_remover: PeerRemover,
}

impl EndpointPeerRef {
    /// Creates a new `EndpointPeerRef`
    pub(super) fn new(endpoint: String, connection_id: String, peer_remover: PeerRemover) -> Self {
        EndpointPeerRef {
            endpoint,
            connection_id,
            peer_remover,
        }
    }

    /// Returns the endpoint of the peer this reference is for
    pub fn endpoint(&self) -> &str {
        &self.endpoint
    }
}

impl Drop for EndpointPeerRef {
    fn drop(&mut self) {
        match self
            .peer_remover
            .remove_peer_ref_by_endpoint(&self.endpoint, &self.connection_id)
        {
            Ok(_) => (),
            Err(err) => error!(
                "Unable to remove reference to peer with endpoint {} on drop: {}",
                self.endpoint, err
            ),
        }
    }
}