Skip to content

Commit 1333cc0

Browse files
committed
Merge #257: docs: crate docs for lib.rs
78f295b docs: [#253] crate docs for app.rs (Jose Celano) a58554a docs: [#253] crate docs for lib.rs (Jose Celano) Pull request description: Entrypoint for the crate documentation, the `lib.rs` file. Top commit has no ACKs. Tree-SHA512: ec13ffc6408f3cf06da59cf639807e11b8e5baecbcad016ec8662753ff53cc9e971bff1e9ae3979ae729def9f3ab8a63d884584dba4a56d58fb0c8510c3daf1d
2 parents 62cd78f + 78f295b commit 1333cc0

File tree

4 files changed

+443
-0
lines changed

4 files changed

+443
-0
lines changed

cSpell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"Azureus",
88
"bencode",
99
"bencoded",
10+
"beps",
1011
"binascii",
1112
"Bitflu",
1213
"bools",
82.9 KB
Loading

src/app.rs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
//! Torrust Tracker application.
2+
//!
3+
//! The tracker application has a global configuration for multiple jobs.
4+
//! It's basically a container for other services.
5+
//! It also check constraint and dependencies between services. For example:
6+
//! It's not safe to run a UDP tracker on top of a core public tracker, as UDP trackers
7+
//! do not allow private access to the tracker data.
8+
//!
9+
//! The application is responsible for:
10+
//!
11+
//! - Loading data from the database when it's needed.
12+
//! - Starting some jobs depending on the configuration.
13+
//!
14+
//! The started jobs may be:
15+
//!
16+
//! - Torrent cleaner: it removes inactive peers and (optionally) peerless torrents.
17+
//! - UDP trackers: the user can enable multiple UDP tracker on several ports.
18+
//! - HTTP trackers: the user can enable multiple HTTP tracker on several ports.
19+
//! - Tracker REST API: the tracker API can be enabled/disabled.
120
use std::sync::Arc;
221

322
use log::warn;

0 commit comments

Comments
 (0)