TorrentDest (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- org.klomp.snark.TorrentDest

```
public class TorrentDest
extends Object
```
Bundles the transient I2P destination, session, server socket, DHT instance, and UDP tracker client for one torrent or for a pool of torrents, so that all of a torrent's network activity goes out through its own identity. Created lazily when a torrent starts, destroyed when its last torrent stops, and recreated by the pooling logic when a pool index is reused. Not persisted; a new destination is generated on each start.

Field Summary
Fields
Modifier and Type Field and Description
static String PROP_POOL_MEMBERS
Session property carrying the pool's torrent names, for the /tunnels pool tooltip

Fields
Modifier and Type	Field and Description
`static String`	`PROP_POOL_MEMBERS` Session property carrying the pool's torrent names, for the /tunnels pool tooltip

Constructor Summary

Constructors
Constructor and Description
`TorrentDest(I2PAppContext ctx, String key, int poolIndex, int poolNum, I2PSocketManager mgr, I2PServerSocket serverSocket)` Assign a torrent to this destination.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assign(String key, InfoHash ih, String name)` Assign a torrent to this destination, serving its infohash on the DHT instance when one already runs, and updating the pool tooltip and tunnel nickname.
`void`	`destroy()` Stop the DHT instance and UDP tracker client and destroy the destination.
`TorrentKRPC`	`getDHT(KRPC shared)` Lazily create the DHT instance on this destination's session, sharing the main instance's routing table, tracker, and blacklist, serving tracker queries only for the torrents assigned here.
`String`	`getKey()` The Base64-encoded info hash of the first torrent assigned.
`Destination`	`getMyDestination()` The destination, or null.
`int`	`getPoolIndex()` The shared pool index, or -1 when dedicated to a single torrent.
`int`	`getPoolNum()` The sequential pool number shown in the tunnel nickname "I2PSnark - Pool <n>", or -1 when dedicated to a single torrent.
`I2PServerSocket`	`getServerSocket()`
`I2PSocketManager`	`getSocketManager()`
`UDPTrackerClient`	`getUDPTracker(I2PSnarkUtil util)` Lazily create the UDP tracker client on this destination's session.
`boolean`	`unassign(String key)` Remove a torrent from this destination, stopping its DHT serving when an instance runs and updating the pool tooltip and tunnel nickname.

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

- Field Detail
  - PROP_POOL_MEMBERS
```
public static final String PROP_POOL_MEMBERS
```
    Session property carrying the pool's torrent names, for the /tunnels pool tooltip
    See Also:
    Constant Field Values
- Constructor Detail
  - TorrentDest
```
public TorrentDest(I2PAppContext ctx,
                   String key,
                   int poolIndex,
                   int poolNum,
                   I2PSocketManager mgr,
                   I2PServerSocket serverSocket)
```
    Assign a torrent to this destination.
    Parameters:
    key - Base64 encoding of the first torrent's info hash
    poolIndex - the shared pool index, or -1 for a dedicated destination
    poolNum - the sequential pool number for the nickname, -1 when dedicated
    mgr - the socket manager of the new transient destination; must be connected
    serverSocket - the destination's server socket, or null
- Method Detail
  - assign
```
public void assign(String key,
                   InfoHash ih,
                   String name)
```
    Assign a torrent to this destination, serving its infohash on the DHT instance when one already runs, and updating the pool tooltip and tunnel nickname. The nickname changes only when the pool crosses the one-to-two torrent boundary; further members keep the pool name until the pool reverts to a single torrent.
    Parameters:
    key - the Base64-encoded info hash key
    ih - the torrent's info hash
    name - the torrent name, shown in the pool tooltip
  - destroy
```
public void destroy()
```
    Stop the DHT instance and UDP tracker client and destroy the destination. Call only when no torrents remain assigned.
  - getDHT
```
public TorrentKRPC getDHT(KRPC shared)
```
    Lazily create the DHT instance on this destination's session, sharing the main instance's routing table, tracker, and blacklist, serving tracker queries only for the torrents assigned here.
    Parameters:
    shared - the main DHT instance, or null if the DHT is disabled
    Returns:
    the DHT instance, or null if disabled
  - getKey
```
public String getKey()
```
    The Base64-encoded info hash of the first torrent assigned.
    Returns:
    the Base64-encoded info hash of the first torrent assigned
  - getMyDestination
```
public Destination getMyDestination()
```
    The destination, or null.
    Returns:
    the destination, or null
  - getPoolIndex
```
public int getPoolIndex()
```
    The shared pool index, or -1 when dedicated to a single torrent.
    Returns:
    the shared pool index, or -1 when dedicated to a single torrent
  - getPoolNum
```
public int getPoolNum()
```
    The sequential pool number shown in the tunnel nickname "I2PSnark - Pool <n>", or -1 when dedicated to a single torrent.
    Returns:
    the pool number, or -1 when dedicated
  - getServerSocket
```
public I2PServerSocket getServerSocket()
```
  - getSocketManager
```
public I2PSocketManager getSocketManager()
```
  - getUDPTracker
```
public UDPTrackerClient getUDPTracker(I2PSnarkUtil util)
```
    Lazily create the UDP tracker client on this destination's session.
    Parameters:
    util - the shared util, for destination lookups
    Returns:
    the tracker client, or null if the session is gone
  - unassign
```
public boolean unassign(String key)
```
    Remove a torrent from this destination, stopping its DHT serving when an instance runs and updating the pool tooltip and tunnel nickname. The nickname reverts to the remaining torrent's name when the pool drops back to a single torrent.
    Parameters:
    key - the Base64-encoded info hash key
    Returns:
    true when no torrents remain assigned

Class TorrentDest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_POOL_MEMBERS

Constructor Detail

TorrentDest

Method Detail

assign

destroy

getDHT

getKey

getMyDestination

getPoolIndex

getPoolNum

getServerSocket

getSocketManager

getUDPTracker

unassign