torrust-actix 4.2.3

A rich, fast and efficient Bittorrent Tracker.
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

use crate::cache::structs::cache_connector::CacheConnector;
use crate::config::structs::configuration::Configuration;
use crate::database::structs::database_connector::DatabaseConnector;
use crate::ssl::structs::certificate_store::CertificateStore;
use crate::stats::structs::stats_atomics::StatsAtomics;
use crate::tracker::enums::updates_action::UpdatesAction;
use crate::tracker::structs::info_hash::InfoHash;
use crate::tracker::structs::torrent_sharding::TorrentSharding;
use crate::tracker::structs::user_entry_item::UserEntryItem;
use crate::tracker::structs::user_id::UserId;
use crate::tracker::types::keys_updates::KeysUpdates;
use crate::tracker::types::torrents_updates::TorrentsUpdates;
use crate::tracker::types::users_updates::UsersUpdates;
use parking_lot::RwLock;
use std::collections::{
    BTreeMap,
    HashMap,
    HashSet
};
use std::sync::Arc;

/// Central tracker state shared across all request handlers.
///
/// A single `TorrentTracker` is created at startup and wrapped in an [`Arc`]
/// so it can be cheaply cloned into each Actix worker thread and each UDP
/// receive task.
///
/// # Concurrency
///
/// Torrent data is stored in [`TorrentSharding`] — 256 independently-locked
/// `BTreeMap` shards — so most announce requests are lock-free with respect to
/// each other.  Whitelist, blacklist, key, and user tables use separate
/// `parking_lot::RwLock`s.
///
/// # Persistence
///
/// Dirty entries are accumulated in the `*_updates` fields and flushed to the
/// database on a configurable interval by the background save task.
#[derive(Debug)]
pub struct TorrentTracker {
    /// Shared application configuration.
    pub config: Arc<Configuration>,
    /// Async database connection (SQLite 3 / MySQL / PostgreSQL).
    pub sqlx: DatabaseConnector,
    /// Optional Redis or Memcache connector for peer-data caching.
    pub cache: Option<CacheConnector>,
    /// Hot-reloadable TLS certificate store used by HTTP and API servers.
    pub certificate_store: Arc<CertificateStore>,
    /// Sharded in-memory torrent map (256 shards).
    pub torrents_sharding: Arc<TorrentSharding>,
    /// Pending torrent stat changes awaiting the next database flush.
    pub torrents_updates: TorrentsUpdates,
    /// Set of info-hashes allowed when whitelist mode is active.
    pub torrents_whitelist: Arc<RwLock<HashSet<InfoHash>>>,
    /// Pending whitelist additions/removals awaiting the next database flush.
    pub torrents_whitelist_updates: Arc<RwLock<HashMap<u128, (InfoHash, UpdatesAction)>>>,
    /// Set of info-hashes blocked when blacklist mode is active.
    pub torrents_blacklist: Arc<RwLock<HashSet<InfoHash>>>,
    /// Pending blacklist additions/removals awaiting the next database flush.
    pub torrents_blacklist_updates: Arc<RwLock<HashMap<u128, (InfoHash, UpdatesAction)>>>,
    /// Active announce keys mapped to their expiry timestamp (`0` = permanent).
    pub keys: Arc<RwLock<BTreeMap<InfoHash, i64>>>,
    /// Pending key additions/removals awaiting the next database flush.
    pub keys_updates: KeysUpdates,
    /// Registered users indexed by their [`UserId`].
    pub users: Arc<RwLock<BTreeMap<UserId, UserEntryItem>>>,
    /// Pending user stat changes awaiting the next database flush.
    pub users_updates: UsersUpdates,
    /// Atomic statistics counters (connections, announces, scrapes, …).
    pub stats: Arc<StatsAtomics>
}