MonoTorrent Documentation

The TrackerManager (implementing ITrackerManager) is responsible for managing connections to trackers for a torrent. It handles adding/removing trackers, performing announces (notifying trackers of client state), and performing scrapes (requesting information from trackers).

Key behaviors:

• Private Torrents: If the Private property is true, calling AddTrackerAsync or RemoveTrackerAsync will throw an InvalidOperationException.
• Concurrency: The manager enforces concurrency limits to prevent overwhelming the engine or trackers.
• Events: You can subscribe to AnnounceComplete and ScrapeComplete to react to tracker communication results.

The TorrentFileInfo class provides metadata and state for individual files within a torrent managed by MonoTorrent. It tracks file paths (complete, incomplete, and current), download progress via a BitField, and file properties like size and piece indices.

Key properties include:

• Path: The relative path of the file within the torrent.
• Length: The expected size of the file once fully downloaded.
• CachedActualLength: The actual size of the file on-disk (used during fast resume or hashing).
• Priority: The download priority of the file (defaults to Priority.Normal).
• FullPath, DownloadCompleteFullPath, and DownloadIncompleteFullPath: The various filesystem paths associated with the file.
• BitField: A representation of which pieces of the file have been downloaded.
• IncompleteFileSuffix: The suffix used for partial files, which is .!mt.

Use RemoveTrackerAsync(ITracker tracker) to remove a specific tracker from the manager. Returns true if the tracker was successfully removed, or false if the tracker was not found in any tier.

If the torrent is Private, this will throw an InvalidOperationException.

Announcing notifies the tracker of the client's current state (e.g., peer list, upload/download status). You can trigger a general announce for all trackers or a specific announce for a single tracker.

Available methods:

• AnnounceAsync(CancellationToken token): Triggers a regular announce cycle for all applicable trackers.
• AnnounceAsync(TorrentEvent clientEvent, CancellationToken token): Triggers an announce associated with a specific TorrentEvent.
• AnnounceAsync(ITracker tracker, CancellationToken token): Triggers an announce specifically for the provided ITracker.

You can add a tracker to a torrent using either an ITracker instance or a Uri. Note that if the torrent is marked as Private, these operations will throw an InvalidOperationException.

Use AddTrackerAsync(ITracker tracker) or AddTrackerAsync(Uri trackerUri).

The TrackerManager exposes events that allow you to monitor the completion of tracker communications.

• AnnounceComplete: Fired when an announce request completes. Provides AnnounceResponseEventArgs.
• ScrapeComplete: Fired when a scrape request completes. Provides ScrapeResponseEventArgs.

When working with PieceHashesV2, you can inspect the following properties:

• Count: The total number of hashes (equivalent to the number of pieces).
• HasV1Hashes: Always returns false for this implementation.
• HasV2Hashes: Always returns true for this implementation.

Use GetHash(int hashIndex) to retrieve the hash for a specific piece in a torrent using the V2 specification. The method returns a ReadOnlyPieceHash containing the hash data.

Note that hashIndex must be within the range of 0 to Count - 1. If the requested index is out of bounds or refers to a non-existent piece, an exception is thrown.

Scraping requests information from the tracker (such as the number of seeders and leechers) without updating the client's state.

Available methods:

• ScrapeAsync(CancellationToken token): Scrapes all applicable trackers.
• ScrapeAsync(ITracker tracker, CancellationToken token): Scrapes a specific tracker. This will throw a TorrentException if the tracker does not support scraping.