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

// Copyright 2016 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License,
// version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which
// licence you accepted on initial access to the Software (the "Licences").
//
// By contributing code to the SAFE Network Software, or to this project generally, you agree to be
// bound by the terms of the MaidSafe Contributor Agreement.  This, along with the Licenses can be
// found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR.
//
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.
//
// Please review the Licences for the specific language governing permissions and limitations
// relating to use of the SAFE Network Software.

use errors::CoreError;
use futures::sync::mpsc;
use routing::{AccountInfo, ImmutableData, MutableData, PermissionSet, User, Value};
use rust_sodium::crypto::sign;
use std::collections::{BTreeMap, BTreeSet};

/// Network Events will be translated into values starting from this number for
/// propagating them beyond the FFI boudaries when required
pub const NETWORK_EVENT_START_RANGE: i32 = 0;

/// Wraps responses from routing
#[cfg_attr(feature = "cargo-clippy", allow(large_enum_variant))]
#[derive(Debug)]
pub enum CoreEvent {
    /// Result of getting account info
    GetAccountInfo(Result<AccountInfo, CoreError>),
    /// Result of data mutation request
    Mutation(Result<(), CoreError>),
    /// Result of getting `ImmutableData`
    GetIData(Result<ImmutableData, CoreError>),
    /// Result of getting a version of `MutableData`
    GetMDataVersion(Result<u64, CoreError>),
    /// Result of getting a list of `MutableData` entries
    ListMDataEntries(Result<BTreeMap<Vec<u8>, Value>, CoreError>),
    /// Result of getting a list of `MutableData` keys
    ListMDataKeys(Result<BTreeSet<Vec<u8>>, CoreError>),
    /// Result of getting a list of `MutableData` keys
    ListMDataValues(Result<Vec<Value>, CoreError>),
    /// Result of getting a single value from `MutableData`
    GetMDataValue(Result<Value, CoreError>),
    /// Result of getting a list of all `MutableData` permissions
    ListMDataPermissions(Result<BTreeMap<User, PermissionSet>, CoreError>),
    /// Result of getting a list of permissions in `MutableData` for a single user
    ListMDataUserPermissions(Result<PermissionSet, CoreError>),
    /// Result of getting a list of authorised keys
    ListAuthKeysAndVersion(Result<(BTreeSet<sign::PublicKey>, u64), CoreError>),
    /// Result of getting a mutable data shell
    GetMDataShell(Result<MutableData, CoreError>),
    /// Result of getting entire mutable data
    GetMData(Result<MutableData, CoreError>),
    /// Rate limit exeeded
    RateLimitExceeded,
}

/// Netowork Events that Client Modules need to deal with
#[derive(Debug)]
pub enum NetworkEvent {
    /// The core engine is connected to atleast one peer
    Connected,
    /// The core engine is disconnected from the network (under usual
    /// circumstances this would indicate that client connection to proxy node
    /// has been lost)
    Disconnected,
}

impl Into<i32> for NetworkEvent {
    fn into(self) -> i32 {
        match self {
            NetworkEvent::Connected => NETWORK_EVENT_START_RANGE,
            NetworkEvent::Disconnected => NETWORK_EVENT_START_RANGE - 1,
        }
    }
}

/// `NetworkEvent` receiver stream.
pub type NetworkRx = mpsc::UnboundedReceiver<NetworkEvent>;
/// `NetworkEvent` transmitter.
pub type NetworkTx = mpsc::UnboundedSender<NetworkEvent>;