Snark (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

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

All Implemented Interfaces:
CoordinatorListener, ShutdownListener, StorageListener
Direct Known Subclasses:
FetchAndAdd
```
public class Snark
extends Object
implements StorageListener, CoordinatorListener, ShutdownListener
```
Main Snark program startup class.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
(package private) static class Snark.RouterException
A unique exception class to blame the router that can be caught by SnarkManager

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`Snark.RouterException` A unique exception class to blame the router that can be caught by SnarkManager

Field Summary

Fields
Modifier and Type	Field and Description
`protected I2PSnarkUtil`	`_util` The util
`(package private) static int`	`MAX_TOTAL_UPLOADERS` M a x t o t a l u p l o a d e r s
`(package private) static int`	`MIN_TOTAL_UPLOADERS` Maintain a configurable total uploader cap CoordinatorListener
`static String`	`PROP_MAX_CONNECTIONS` max connections
`boolean`	`storageCompleted` Whether the torrent storage has reported completion.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Snark(I2PSnarkUtil util, String torrent, byte[] ih, String trackerURL, CompleteListener complistener, PeerCoordinatorSet peerCoordinatorSet, ConnectionAcceptor connectionAcceptor, boolean ignored, String rootDir)` multitorrent, magnet, Used by snark-rpc plugin
	`Snark(I2PSnarkUtil util, String torrent, byte[] ih, String trackerURL, CompleteListener complistener, PeerCoordinatorSet peerCoordinatorSet, ConnectionAcceptor connectionAcceptor, String rootDir)` multitorrent, magnet
	`Snark(I2PSnarkUtil util, String torrent, String ip, int user_port, StorageListener slistener, CoordinatorListener clistener, CompleteListener complistener, PeerCoordinatorSet peerCoordinatorSet, ConnectionAcceptor connectionAcceptor, String rootDir)` multitorrent
	`Snark(I2PSnarkUtil util, String torrent, String ip, int user_port, StorageListener slistener, CoordinatorListener clistener, CompleteListener complistener, PeerCoordinatorSet peerCoordinatorSet, ConnectionAcceptor connectionAcceptor, String rootDir, File baseFile)` multitorrent

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addComments(List<Comment> comments)` Add to the current comment set for this torrent, creating it if it didn't previously exist.
`void`	`addMessage(String message)` StorageListener and CoordinatorListener callback
`String`	`getBaseName()` Get the base name of the torrent.
`double`	`getCheckingProgress()` Get the progress of file checking as a percentage.
`CommentSet`	`getComments()` The current comment set for this torrent.
`long`	`getDownloaded()` Get the total number of bytes downloaded.
`long`	`getDownloadRate()` Get the current download rate in bytes per second.
`byte[]`	`getID()` Get the peer ID.
`byte[]`	`getInfoHash()` Get the info hash.
`MetaInfo`	`getMetaInfo()` Get the metainfo.
`String`	`getName()` Get the file name of the .torrent file.
`long`	`getNeeded()` Does not account (i.e.
`long`	`getNeededLength()` Bytes still wanted.
`int`	`getPeerCount()` Get the peer count.
`List<Peer>`	`getPeerList()` Get the peer list.
`int`	`getPieceLength(int p)` Get the piece length.
`int`	`getPieces()` Get the number of pieces.
`long`	`getRemainingLength()` Bytes not yet in storage.
`int`	`getRPCID()` A unique ID for this torrent, useful for RPC
`long`	`getSkippedLength()` Bytes not received and set to skipped.
`long`	`getStartedTime()` When did we start this torrent For RPC
`Storage`	`getStorage()` Get the storage.
`long`	`getTotalLength()` Get the total length of all torrent files.
`String`	`getTrackerProblems()` Not HTML escaped.
`int`	`getTrackerSeenPeers()` Get the tracker seen peers count.
`String`	`getTrackerURL()` Get the tracker URL.
`long`	`getUploaded()` Get the total number of bytes uploaded.
`long`	`getUploadRate()` Get the current upload rate in bytes per second.
`void`	`gotMetaInfo(PeerCoordinator coordinator, MetaInfo metainfo)` Called when the PeerCoordinator got the MetaInfo via magnet.
`boolean`	`isAllocating()` Check if disk allocation (ballooning) is in progress.
`boolean`	`isAutoStoppable()` Check if the torrent is auto-stoppable.
`boolean`	`isChecking()` Check if file checking is in progress.
`boolean`	`isNotificationSent()`
`boolean`	`isStarting()` Check if startup is in progress.
`boolean`	`isStopped()` Check if the torrent is stopped.
`boolean`	`isStorageCompleted()`
`boolean`	`overUploadLimit(int uploaders)` CoordinatorListener callback to check if the total uploaders across all torrents exceeds the configured limit.
`void`	`peerChange(PeerCoordinator coordinator, Peer peer)` CoordinatorListener no-op
`void`	`replaceMetaInfo(MetaInfo metainfo)` Call after editing torrent.
`boolean`	`restartAcceptor()` Restart the connection acceptor.
`void`	`setAutoStoppable(boolean yes)` Set whether the torrent is auto-stoppable.
`void`	`setNotificationSent(boolean sent)` Mark that a completion notification has been sent.
`void`	`setStarting()` Set startup in progress.
`void`	`setTrackerProblems(String p)` Set the tracker problems string.
`void`	`setTrackerSeenPeers(int p)` Set the tracker seen peers count.
`void`	`setWantedPieces(Storage storage)` StorageListener callback to update the coordinator's wanted piece set.
`void`	`shutdown()` SnarkShutdown callback unused
`void`	`startTorrent()` Start up contacting peers and querying the tracker.
`void`	`stopTorrent()` Stop contacting the tracker and talking with peers
`void`	`stopTorrent(boolean fast)` Stop contacting the tracker and talking with peers
`void`	`storageAllChecked(Storage storage)` StorageListener callback called when all pieces have been checked.
`void`	`storageAllocated(Storage storage, long length)` does nothing
`void`	`storageChecked(Storage storage, int num, boolean checked)` StorageListener callback called when a piece check completes.
`void`	`storageCompleted(Storage storage)` StorageListener callback called when the torrent has completed.
`void`	`storageCreateFile(Storage storage, String name, long length)` StorageListener no-op
`void`	`updatePiecePriorities()` Recalculate piece priorities

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

- Field Detail
  - _util
```
protected final I2PSnarkUtil _util
```
    The util
  - MAX_TOTAL_UPLOADERS
```
static final int MAX_TOTAL_UPLOADERS
```
    M a x t o t a l u p l o a d e r s
    See Also:
    Constant Field Values
  - MIN_TOTAL_UPLOADERS
```
static final int MIN_TOTAL_UPLOADERS
```
    Maintain a configurable total uploader cap CoordinatorListener
    See Also:
    Constant Field Values
  - PROP_MAX_CONNECTIONS
```
public static final String PROP_MAX_CONNECTIONS
```
    max connections
    See Also:
    Constant Field Values
  - storageCompleted
```
public boolean storageCompleted
```
    Whether the torrent storage has reported completion.
- Constructor Detail
  - Snark
```
protected Snark(I2PSnarkUtil util,
                String torrent,
                byte[] ih,
                String trackerURL,
                CompleteListener complistener,
                PeerCoordinatorSet peerCoordinatorSet,
                ConnectionAcceptor connectionAcceptor,
                boolean ignored,
                String rootDir)
```
    multitorrent, magnet, Used by snark-rpc plugin
    Will not start itself. Caller must call startTorrent() if desired.
    Parameters:
    util - the I2PSnarkUtil
    torrent - the torrent
    ih - the info hash
    trackerURL - the tracker URL
    complistener - the complete listener
    peerCoordinatorSet - the peer coordinator set
    connectionAcceptor - the connection acceptor
    ignored - used to be autostart
    rootDir - the root data directory
    Throws:
    RuntimeException - via fatal()
    Snark.RouterException - via fatalRouter()
  - Snark
```
public Snark(I2PSnarkUtil util,
             String torrent,
             byte[] ih,
             String trackerURL,
             CompleteListener complistener,
             PeerCoordinatorSet peerCoordinatorSet,
             ConnectionAcceptor connectionAcceptor,
             String rootDir)
```
    multitorrent, magnet
    Will not start itself. Caller must call startTorrent() if desired.
    Parameters:
    util - the I2PSnarkUtil
    torrent - a fake name for now (not a file name)
    ih - 20-byte info hash
    trackerURL - may be null
    complistener - the complete listener
    peerCoordinatorSet - the peer coordinator set
    connectionAcceptor - the connection acceptor
    rootDir - the root data directory
    Throws:
    RuntimeException - via fatal()
    Snark.RouterException - via fatalRouter()
  - Snark
```
public Snark(I2PSnarkUtil util,
             String torrent,
             String ip,
             int user_port,
             StorageListener slistener,
             CoordinatorListener clistener,
             CompleteListener complistener,
             PeerCoordinatorSet peerCoordinatorSet,
             ConnectionAcceptor connectionAcceptor,
             String rootDir)
```
    multitorrent
    Will not start itself. Caller must call startTorrent() if desired.
    Parameters:
    util - the I2PSnarkUtil
    torrent - the torrent
    ip - the IP address
    user_port - the user port
    slistener - the storage listener
    clistener - the coordinator listener
    complistener - the complete listener
    peerCoordinatorSet - the peer coordinator set
    connectionAcceptor - the connection acceptor
    rootDir - the root data directory
    Throws:
    RuntimeException - via fatal()
    Snark.RouterException - via fatalRouter()
  - Snark
```
public Snark(I2PSnarkUtil util,
             String torrent,
             String ip,
             int user_port,
             StorageListener slistener,
             CoordinatorListener clistener,
             CompleteListener complistener,
             PeerCoordinatorSet peerCoordinatorSet,
             ConnectionAcceptor connectionAcceptor,
             String rootDir,
             File baseFile)
```
    multitorrent
    Will not start itself. Caller must call startTorrent() if desired.
    Parameters:
    util - the I2PSnarkUtil
    torrent - the torrent
    ip - the IP address
    user_port - the user port
    slistener - the storage listener
    clistener - the coordinator listener
    complistener - the complete listener
    peerCoordinatorSet - the peer coordinator set
    connectionAcceptor - the connection acceptor
    rootDir - the root data directory
    baseFile - if null, use rootDir/torrentName; if non-null, use it instead
    Throws:
    RuntimeException - via fatal()
    Snark.RouterException - via fatalRouter()
- Method Detail
  - addComments
```
public boolean addComments(List<Comment> comments)
```
    Add to the current comment set for this torrent, creating it if it didn't previously exist.
    Returns:
    true if the set changed
  - addMessage
```
public void addMessage(String message)
```
    StorageListener and CoordinatorListener callback
    Specified by:
    addMessage in interface CoordinatorListener
    Specified by:
    addMessage in interface StorageListener
    Parameters:
    message - the message to display
  - getBaseName
```
public String getBaseName()
```
    Get the base name of the torrent.
    Returns:
    base name of torrent [filtered version of getMetaInfo.getName()], or a fake name if in magnet mode
  - getCheckingProgress
```
public double getCheckingProgress()
```
    Get the progress of file checking as a percentage. If checking is in progress, return completion 0.0 ... 1.0, else return 1.0.
    Returns:
    checking progress as a percentage (0.0 to 1.0)
  - getComments
```
public CommentSet getComments()
```
    The current comment set for this torrent. Not a copy. Caller MUST synch on the returned object for all operations.
    Returns:
    may be null if none
  - getDownloaded
```
public long getDownloaded()
```
    Get the total number of bytes downloaded.
    Returns:
    total bytes downloaded, or 0 if not available
  - getDownloadRate
```
public long getDownloadRate()
```
    Get the current download rate in bytes per second.
    Returns:
    download rate in bytes per second, or 0 if not available
  - getID
```
public byte[] getID()
```
    Get the peer ID.
    Returns:
    always will be valid even in magnet mode
  - getInfoHash
```
public byte[] getInfoHash()
```
    Get the info hash.
    Returns:
    always will be valid even in magnet mode
  - getMetaInfo
```
public MetaInfo getMetaInfo()
```
    Get the metainfo.
    Returns:
    may be null if in magnet mode
  - getName
```
public String getName()
```
    Get the file name of the .torrent file.
    Returns:
    file name of .torrent file (should be full absolute path), or a fake name if in magnet mode.
  - getNeeded
```
public long getNeeded()
```
    Does not account (i.e. includes) for skipped files.
    Returns:
    number of pieces still needed (magnet mode or not), or -1 if unknown
  - getNeededLength
```
public long getNeededLength()
```
    Bytes still wanted. DOES account for (i.e. does not include) skipped files. FIXME -1 when not running.
    Returns:
    exact value. or -1 if no storage yet or when not running.
  - getPeerCount
```
public int getPeerCount()
```
    Get the peer count.
    Returns:
    peer count
  - getPeerList
```
public List<Peer> getPeerList()
```
    Get the peer list.
    Returns:
    peer list
  - getPieceLength
```
public int getPieceLength(int p)
```
    Get the piece length.
    Parameters:
    p - the piece number
    Returns:
    metainfo piece length or 16K if fetching magnet
  - getPieces
```
public int getPieces()
```
    Get the number of pieces.
    Returns:
    number of pieces
  - getRemainingLength
```
public long getRemainingLength()
```
    Bytes not yet in storage. Does NOT account for skipped files.
    Returns:
    exact value. or -1 if no storage yet. getNeeded() * pieceLength(0) isn't accurate if last piece is still needed.
  - getRPCID
```
public int getRPCID()
```
    A unique ID for this torrent, useful for RPC
    Returns:
    positive value unless you wrap around
  - getSkippedLength
```
public long getSkippedLength()
```
    Bytes not received and set to skipped. This is not the same as the total of all skipped files, since pieces may span multiple files.
    Returns:
    exact value. or 0 if no storage yet.
  - getStartedTime
```
public long getStartedTime()
```
    When did we start this torrent For RPC
    Returns:
    0 if not started before. Not cleared when stopped.
  - getStorage
```
public Storage getStorage()
```
    Get the storage.
    Returns:
    may be null if in magnet mode
  - getTotalLength
```
public long getTotalLength()
```
    Get the total length of all torrent files.
    Returns:
    total of all torrent files, or total of metainfo file if fetching magnet, or -1
  - getTrackerProblems
```
public String getTrackerProblems()
```
    Not HTML escaped.
    Returns:
    String returned from tracker, or null if no error
  - getTrackerSeenPeers
```
public int getTrackerSeenPeers()
```
    Get the tracker seen peers count.
    Returns:
    count returned from tracker
  - getTrackerURL
```
public String getTrackerURL()
```
    Get the tracker URL.
    Returns:
    trackerURL string from magnet-mode constructor, may be null
  - getUploaded
```
public long getUploaded()
```
    Get the total number of bytes uploaded.
    Returns:
    total bytes uploaded, including saved uploaded if coordinator is not available
  - getUploadRate
```
public long getUploadRate()
```
    Get the current upload rate in bytes per second.
    Returns:
    upload rate in bytes per second, or 0 if not available
  - gotMetaInfo
```
public void gotMetaInfo(PeerCoordinator coordinator,
                        MetaInfo metainfo)
```
    Called when the PeerCoordinator got the MetaInfo via magnet. CoordinatorListener. Create the storage, tell SnarkManager, and give the storage back to the coordinator.
    Specified by:
    gotMetaInfo in interface CoordinatorListener
    Throws:
    RuntimeException - via fatal()
  - isAllocating
```
public boolean isAllocating()
```
    Check if disk allocation (ballooning) is in progress.
    Returns:
    true if allocating, false otherwise
  - isAutoStoppable
```
public boolean isAutoStoppable()
```
    Check if the torrent is auto-stoppable.
    Returns:
    true if auto-stoppable
  - isChecking
```
public boolean isChecking()
```
    Check if file checking is in progress.
    Returns:
    true if checking is in progress, false otherwise
  - isNotificationSent
```
public boolean isNotificationSent()
```
    Returns:
    true if a completion notification has already been sent for this torrent
  - isStarting
```
public boolean isStarting()
```
    Check if startup is in progress.
    Returns:
    true if starting
  - isStopped
```
public boolean isStopped()
```
    Check if the torrent is stopped.
    Returns:
    true if stopped
  - isStorageCompleted
```
public boolean isStorageCompleted()
```
    Returns:
    true if the torrent storage has completed
  - overUploadLimit
```
public boolean overUploadLimit(int uploaders)
```
    CoordinatorListener callback to check if the total uploaders across all torrents exceeds the configured limit.
    Specified by:
    overUploadLimit in interface CoordinatorListener
    Parameters:
    uploaders - the number of interested uploaders on this coordinator
    Returns:
    true if the global upload limit is exceeded
  - peerChange
```
public void peerChange(PeerCoordinator coordinator,
                       Peer peer)
```
    CoordinatorListener no-op
    Specified by:
    peerChange in interface CoordinatorListener
    Parameters:
    coordinator - the PeerCoordinator reporting the change
    peer - the peer whose state changed
  - replaceMetaInfo
```
public void replaceMetaInfo(MetaInfo metainfo)
```
    Call after editing torrent. Caller must ensure infohash, files, etc. did not change.
  - restartAcceptor
```
public boolean restartAcceptor()
```
    Restart the connection acceptor.
    Returns:
    true if restarted
  - setAutoStoppable
```
public void setAutoStoppable(boolean yes)
```
    Set whether the torrent is auto-stoppable.
    Parameters:
    yes - true if auto-stoppable
  - setNotificationSent
```
public void setNotificationSent(boolean sent)
```
    Mark that a completion notification has been sent.
    Parameters:
    sent - true if the notification was sent
  - setStarting
```
public void setStarting()
```
    Set startup in progress.
  - setTrackerProblems
```
public void setTrackerProblems(String p)
```
    Set the tracker problems string.
    Parameters:
    p - tracker error string or null
  - setTrackerSeenPeers
```
public void setTrackerSeenPeers(int p)
```
    Set the tracker seen peers count.
    Parameters:
    p - peer count from tracker
  - setWantedPieces
```
public void setWantedPieces(Storage storage)
```
    StorageListener callback to update the coordinator's wanted piece set.
    Specified by:
    setWantedPieces in interface StorageListener
    Parameters:
    storage - the storage
  - shutdown
```
public void shutdown()
```
    SnarkShutdown callback unused
    Specified by:
    shutdown in interface ShutdownListener
  - startTorrent
```
public void startTorrent()
```
    Start up contacting peers and querying the tracker. Blocks if tunnel is not yet open.
    Throws:
    RuntimeException - via fatal()
    Snark.RouterException - via fatalRouter()
  - stopTorrent
```
public void stopTorrent()
```
    Stop contacting the tracker and talking with peers
  - stopTorrent
```
public void stopTorrent(boolean fast)
```
    Stop contacting the tracker and talking with peers
    Parameters:
    fast - if true, limit the life of the unannounce threads
  - storageAllChecked
```
public void storageAllChecked(Storage storage)
```
    StorageListener callback called when all pieces have been checked.
    Specified by:
    storageAllChecked in interface StorageListener
    Parameters:
    storage - the storage
  - storageAllocated
```
public void storageAllocated(Storage storage,
                             long length)
```
    does nothing
    Specified by:
    storageAllocated in interface StorageListener
    Parameters:
    storage - the storage instance
    length - the number of bytes allocated
  - storageChecked
```
public void storageChecked(Storage storage,
                           int num,
                           boolean checked)
```
    StorageListener callback called when a piece check completes.
    Specified by:
    storageChecked in interface StorageListener
    Parameters:
    storage - the storage
    num - the piece number
    checked - true if the piece hash was correct
  - storageCompleted
```
public void storageCompleted(Storage storage)
```
    StorageListener callback called when the torrent has completed.
    Specified by:
    storageCompleted in interface StorageListener
    Parameters:
    storage - the storage
  - storageCreateFile
```
public void storageCreateFile(Storage storage,
                              String name,
                              long length)
```
    StorageListener no-op
    Specified by:
    storageCreateFile in interface StorageListener
    Parameters:
    storage - the storage instance
    name - the file name
    length - the file length
  - updatePiecePriorities
```
public void updatePiecePriorities()
```
    Recalculate piece priorities

Class Snark

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_util

MAX_TOTAL_UPLOADERS

MIN_TOTAL_UPLOADERS

PROP_MAX_CONNECTIONS

storageCompleted

Constructor Detail

Snark

Snark

Snark

Snark

Method Detail

addComments

addMessage

getBaseName

getCheckingProgress

getComments

getDownloaded

getDownloadRate

getID

getInfoHash

getMetaInfo

getName

getNeeded

getNeededLength

getPeerCount

getPeerList

getPieceLength

getPieces

getRemainingLength

getRPCID

getSkippedLength

getStartedTime

getStorage

getTotalLength

getTrackerProblems

getTrackerSeenPeers

getTrackerURL

getUploaded

getUploadRate

gotMetaInfo

isAllocating

isAutoStoppable

isChecking

isNotificationSent

isStarting

isStopped

isStorageCompleted

overUploadLimit

peerChange

replaceMetaInfo

restartAcceptor

setAutoStoppable

setNotificationSent

setStarting

setTrackerProblems

setTrackerSeenPeers

setWantedPieces

shutdown

startTorrent

stopTorrent

stopTorrent

storageAllChecked

storageAllocated

storageChecked

storageCompleted

storageCreateFile

updatePiecePriorities