TorrentKRPC

java.lang.Object

org.klomp.snark.dht.KRPC

org.klomp.snark.dht.TorrentKRPC

All Implemented Interfaces:: I2PSessionListener, I2PSessionMuxedListener, DHT

public class TorrentKRPCextends KRPC

A DHT instance for one or more torrents on a shared transient I2P session and destination. Shares the main instance's routing table, tracker, and blacklist, but generates its own NID, query ports, and token maps, so that tokens issued for one destination can never authorize an announce from another, which would make remote nodes store the wrong peer hash for a torrent. Serves tracker queries only for its assigned torrents' infohashes, so probing this destination never reveals torrents hosted elsewhere on the router.

Nested Class Summary
Nested classes/interfaces inherited from class KRPC
KRPC.ReplyWaiter
Modifier and Type
Class
Description
protected class
KRPC.ReplyWaiter
Callback for replies.
Field Summary
Fields inherited from class KRPC
_isRunning, _qPort, _rPort, _session, DHT_FILE_SUFFIX, FAKE_NID, SECURE_NID
Modifier and Type
Field
Description
protected boolean
_isRunning
True between KRPC.start() and stop(), so the reply threads know to keep going.
protected int
_qPort
Signed datagrams.
protected int
_rPort
Unsigned datagrams.
protected I2PSession
_session
Hook to inject and receive datagrams.
static final String
DHT_FILE_SUFFIX
File suffix for DHT persistent storage.
static final NID
FAKE_NID
All-zero NID used for pings.
static final boolean
SECURE_NID
When true, generated NIDs must satisfy a cryptographic puzzle.
Constructor Summary
Constructors
Constructor
Description
TorrentKRPC(I2PAppContext ctx, KRPC shared, I2PSession session, Collection<InfoHash> ihs)
Create a DHT instance on a torrent's transient destination.
Method Summary
All Methods
Modifier and Type
Method
Description
void
start()
Registers the datagram listeners on this instance's own session and ports, without loading the DHT file or starting the cleaner, explorer, tracker, and routing table, which remain the job of the main instance.
void
stop()
Unregisters the datagram listeners, leaving the shared routing table, tracker, and blacklist running for the main instance.
Methods inherited from class KRPC
addServedTorrent, announce, announce, announce, clear, disconnected, errorOccurred, findClosest, getPeersAndAnnounce, getPort, getRPort, heardAbout, messageAvailable, messageAvailable, ping, removeSelf, removeServedTorrent, renderStatusHTML, reportAbuse, setServeAll, size, unannounce
Modifier and Type
Method
Description
void
addServedTorrent(InfoHash ih)
Serve tracker queries for the given infohash in addition to any already served.
void
announce(byte[] ih, boolean isSeed)
Announce to ourselves.
void
announce(byte[] ih, byte[] peerHash, boolean isSeed)
Announce somebody else we know about to ourselves.
int
announce(byte[] ih, int max, long maxWait, boolean isSeed)
Not recommended - use KRPC.getPeersAndAnnounce(byte[], int, long, int, long, boolean, boolean).
void
clear()
Clears the tracker and DHT data.
void
disconnected(I2PSession session)
Handle a session disconnect.
void
errorOccurred(I2PSession session, String message, Throwable error)
Handle a session error.
List<NodeInfo>
findClosest(byte[] ih, int max)
Local lookup only.
Collection<Hash>
getPeersAndAnnounce(byte[] ih, int max, long maxWait, int annMax, long annMaxWait, boolean isSeed, boolean noSeeds)
Find peers for a torrent, announcing to the closest annMax nodes found.
int
getPort()
The UDP query port.
int
getRPort()
The UDP response port.
(package private) NodeInfo
heardAbout(NodeInfo nInfo)
Called for bootstrap or for all nodes in a receiveNodes reply.
void
messageAvailable(I2PSession session, int msgId, long size)
For non-muxed.
void
messageAvailable(I2PSession session, int msgId, long size, int proto, int fromPort, int toPort)
Instruct the client that the given session has received a message.
void
ping(Destination dest, int port)
Ping.
(package private) static List<NodeInfo>
removeSelf(List<NodeInfo> nodes, NodeInfo self)
Remove any entries equal to ourselves from a list of candidate nodes.
void
removeServedTorrent(InfoHash ih)
Stop serving tracker queries for the given infohash.
String
renderStatusHTML()
Debug info, HTML formatted.
void
reportAbuse(I2PSession session, int severity)
Handle a reportAbuse message from the session.
void
setServeAll(boolean serveAll)
Whether tracker queries are served for every infohash.
int
size()
Known nodes, not estimated total network size.
void
unannounce(byte[] ih)
Remove reference to ourselves in the local tracker.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- TorrentKRPC
  public TorrentKRPC(I2PAppContext ctx, KRPC shared, I2PSession session, Collection<InfoHash> ihs)
  Create a DHT instance on a torrent's transient destination.
  Parameters:
  ctx - the application context owning the session and logging
  shared - the main DHT instance, whose routing table, tracker, and blacklist are shared; must be started already
  session - the transient session of the torrents' destination
  ihs - the infohashes of the torrents served on this destination
Method Details
- start
  public void start()
  Registers the datagram listeners on this instance's own session and ports, without loading the DHT file or starting the cleaner, explorer, tracker, and routing table, which remain the job of the main instance.
  Overrides:
  start in class KRPC
- stop
  public void stop()
  Unregisters the datagram listeners, leaving the shared routing table, tracker, and blacklist running for the main instance.
  Specified by:
  stop in interface DHT
  Overrides:
  stop in class KRPC

Nested Class Summary

Nested classes/interfaces inherited from class KRPC

Field Summary

Fields inherited from class KRPC

Constructor Summary

Method Summary

Methods inherited from class KRPC

Methods inherited from class Object

Constructor Details

Method Details

start

stop