com.frostwire.jlibtorrent.TorrentFlags

public final class TorrentFlags extends Object

Flags controlling torrent startup behavior and operating modes.

TorrentFlags provides a collection of static flags used to configure how torrents are added and started. These flags control important modes like seeding, pausing, sharing, DHT participation, and other behaviors. Flags are combined using bitwise OR and passed via AddTorrentParams.flags().

Common Torrent Operating Modes:

SEED_MODE: Skip initial hash check (assume files are already valid)
UPLOAD_MODE: Don't download, only upload (for disk I/O error recovery)
SHARE_MODE: Download only as much as uploaded (ratio-limited mode)
AUTO_MANAGED: Let session queue and manage torrent automatically
PAUSED: Start in paused state (no connections until resumed)

Using Torrent Flags:

 AddTorrentParams params = new AddTorrentParams();

 // Add a flag (single flag)
 params.flags(TorrentFlags.SEED_MODE);

 // Combine multiple flags using bitwise OR
 torrent_flags_t flags = TorrentFlags.PAUSED
     .or(TorrentFlags.AUTO_MANAGED)
     .or(TorrentFlags.UPDATE_SUBSCRIBE);
 params.flags(flags);

 // Check if a flag is set (using bitwise AND)
 if ((flags.and(TorrentFlags.PAUSED).value() != 0)) {
     System.out.println(\"Torrent will start paused\");
 }

Key Flags Explained:

 SEED_MODE:
   - Assumes all files exist and match torrent hashes
   - Skips initial hash verification on startup
   - Significant speedup for known-valid files
   - If hash mismatch: auto-leaves seed mode and rechecks
   - Useful for: torrenting files you created, resumed downloads

 UPLOAD_MODE:
   - No piece requests made (won't download)
   - Only uploads available pieces
   - Auto-entered on disk I/O errors
   - Use when recovering from disk problems
   - If auto_managed: periodically tries to recover

 SHARE_MODE:
   - Downloads only as much as uploaded to swarm
   - Maintains upload/download ratio ~1.0
   - Used for ratio-conscious uploading
   - Maintains share ratio target (see settings_pack)
   - Don't modify priorities in share mode

 AUTO_MANAGED:
   - Session automatically queues and starts torrents
   - Default torrent ordering by add order
   - Automatically resumed/paused based on queue
   - For manual control: don't set this flag
   - See settings_pack for queue limits

 PAUSED:
   - Torrent added in paused state
   - No tracker or peer connections until resumed
   - Good for setting priorities before starting
   - Prevents race conditions with configuration

Advanced Flags:

 // Stop when ready to download/seed
 params.flags(TorrentFlags.STOP_WHEN_READY);
 // Torrent will force-stop as soon as ready to download
 // Useful for: checking files, moving to archive, etc

 // Super seeding mode (only have complete pieces available)
 params.flags(TorrentFlags.SUPER_SEEDING);
 // Optimizes seeding of rare content

 // Sequential download (pieces in order)
 params.flags(TorrentFlags.SEQUENTIAL_DOWNLOAD);
 // Good for: streaming, preview-first scenarios

 // DHT and peer exchange control
 params.flags(TorrentFlags.DISABLE_DHT);
 params.flags(TorrentFlags.DISABLE_PEX);
 params.flags(TorrentFlags.DISABLE_LSD);
 // Disable specific peer discovery methods

Network Features Control:

 // Disable DHT for privacy (tracker only)
 torrent_flags_t flags = TorrentFlags.DISABLE_DHT;

 // Disable peer exchange (for private torrents)
 flags = flags.or(TorrentFlags.DISABLE_PEX);

 // Disable local service discovery (for privacy)
 flags = flags.or(TorrentFlags.DISABLE_LSD);

 // IP filter policy for this torrent
 torrent_flags_t withFilter = TorrentFlags.APPLY_IP_FILTER;
 // (or leave unset to exempt from IP filter)

Tracker and Web Seed Override:

 // Replace torrent's trackers with these
 params.flags(TorrentFlags.OVERRIDE_TRACKERS);
 params.trackers(...);  // Your tracker list replaces torrent's

 // Replace torrent's web seeds with these
 params.flags(TorrentFlags.OVERRIDE_WEB_SEEDS);
 params.webSeeds(...);  // Your web seeds replace torrent's

 // (Without these flags, new trackers/seeds are added to torrent's list)

Resume Data and Updates:

 // Mark that resume data needs saving
 torrent_flags_t flags = TorrentFlags.NEED_SAVE_RESUME;
 // Cleared after successful save_resume_data()

 // Subscribe to torrent status updates
 params.flags(TorrentFlags.UPDATE_SUBSCRIBE);
 // Torrent included in post_torrent_updates() results

Practical Examples:

 // Example 1: Add a new torrent, start paused and auto-managed
 AddTorrentParams params = new AddTorrentParams();
 params.flags(TorrentFlags.PAUSED.or(TorrentFlags.AUTO_MANAGED));
 // Torrent will be queued, not started until previous torrents complete

 // Example 2: Seed-only (no downloading)
 params.flags(TorrentFlags.SEED_MODE.or(TorrentFlags.UPLOAD_MODE));
 // Torrent acts as seeder, won't download incomplete pieces

 // Example 3: Quick-start with resume data
 params.flags(TorrentFlags.SEED_MODE);
 params.resumeData(previousResumeData);
 // Skips hash check + resumes from where it was

 // Example 4: Private torrent (no DHT/PEX/LSD)
 torrent_flags_t privacy = TorrentFlags.DISABLE_DHT
     .or(TorrentFlags.DISABLE_PEX)
     .or(TorrentFlags.DISABLE_LSD);
 params.flags(privacy);
 // Uses only tracker and direct peer connections

 // Example 5: For-preview streaming
 torrent_flags_t streaming = TorrentFlags.SEQUENTIAL_DOWNLOAD
     .or(TorrentFlags.AUTO_MANAGED);
 params.flags(streaming);
 // Downloads pieces in order for streaming playback

Flag Combinations and Interactions:

AUTO_MANAGED + PAUSED: Queues torrent for auto-starting
SEED_MODE + UPLOAD_MODE: Complete seeder (no pieces to download)
SHARE_MODE + SEQUENTIAL_DOWNLOAD: Doesn't work well (conflicting strategies)
STOP_WHEN_READY: Cancels if already in data-transfer state

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

ALL

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

APPLY_IP_FILTER

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

AUTO_MANAGED

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

DISABLE_DHT

Set this flag to disable DHT for this torrent.

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

DISABLE_LSD

Set this flag to disable local service discovery for this torrent.

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

DISABLE_PEX

Set this flag to disable peer exchange for this torrent.

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

DUPLICATE_IS_ERROR

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

NEED_SAVE_RESUME

If this flag is set (which it is by default) the torrent will be considered needing to save its resume data immediately as it's added.

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

OVERRIDE_TRACKERS

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

OVERRIDE_WEB_SEEDS

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

PAUSED

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

SEED_MODE

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

SEQUENTIAL_DOWNLOAD

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

SHARE_MODE

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

STOP_WHEN_READY

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

SUPER_SEEDING

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

UPDATE_SUBSCRIBE

static final com.frostwire.jlibtorrent.swig.torrent_flags_t

UPLOAD_MODE
Method Summary

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- SEED_MODE
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t SEED_MODE
- UPLOAD_MODE
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t UPLOAD_MODE
- SHARE_MODE
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t SHARE_MODE
- APPLY_IP_FILTER
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t APPLY_IP_FILTER
- PAUSED
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t PAUSED
- AUTO_MANAGED
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t AUTO_MANAGED
- DUPLICATE_IS_ERROR
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t DUPLICATE_IS_ERROR
- UPDATE_SUBSCRIBE
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t UPDATE_SUBSCRIBE
- SUPER_SEEDING
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t SUPER_SEEDING
- SEQUENTIAL_DOWNLOAD
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t SEQUENTIAL_DOWNLOAD
- STOP_WHEN_READY
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t STOP_WHEN_READY
- OVERRIDE_TRACKERS
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t OVERRIDE_TRACKERS
- OVERRIDE_WEB_SEEDS
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t OVERRIDE_WEB_SEEDS
- NEED_SAVE_RESUME
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t NEED_SAVE_RESUME
  
  If this flag is set (which it is by default) the torrent will be considered needing to save its resume data immediately as it's added. New torrents that don't have any resume data should do that. This flag is cleared by a successful call to save_resume_data()
- DISABLE_DHT
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t DISABLE_DHT
  
  Set this flag to disable DHT for this torrent. This lets you have the DHT enabled for the whole client, and still have specific torrents not participating in it. i.e. not announcing to the DHT nor picking up peers from it.
- DISABLE_LSD
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t DISABLE_LSD
  
  Set this flag to disable local service discovery for this torrent.
- DISABLE_PEX
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t DISABLE_PEX
  
  Set this flag to disable peer exchange for this torrent.
- ALL
  
  public static final com.frostwire.jlibtorrent.swig.torrent_flags_t ALL

Class TorrentFlags

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

SEED_MODE

UPLOAD_MODE

SHARE_MODE

APPLY_IP_FILTER

PAUSED

AUTO_MANAGED

DUPLICATE_IS_ERROR

UPDATE_SUBSCRIBE

SUPER_SEEDING

SEQUENTIAL_DOWNLOAD

STOP_WHEN_READY

OVERRIDE_TRACKERS

OVERRIDE_WEB_SEEDS

NEED_SAVE_RESUME

DISABLE_DHT

DISABLE_LSD

DISABLE_PEX

ALL