Snark (I2P Anonymous Network - Java Documentation

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

すべての実装されたインタフェース:

CoordinatorListener, ShutdownListener, StorageListener

直系の既知のサブクラス:

FetchAndAdd
```
public class Snark
extends java.lang.Object
implements StorageListener, CoordinatorListener, ShutdownListener
```
Main Snark program startup class.

作成者:

Mark Wielaard (mark@klomp.org)

フィールドの概要

フィールド
修飾子とタイプ	フィールド	説明
`protected I2PSnarkUtil`	`_util`
`(package private) static int`	`MAX_TOTAL_UPLOADERS`
`(package private) static int`	`MIN_TOTAL_UPLOADERS`	Maintain a configurable total uploader cap coordinatorListener
`static java.lang.String`	`PROP_MAX_CONNECTIONS`	max connections

コンストラクタの概要

コンストラクタ
コンストラクタ	説明
`Snark(I2PSnarkUtil util, java.lang.String torrent, byte[] ih, java.lang.String trackerURL, CompleteListener complistener, PeerCoordinatorSet peerCoordinatorSet, ConnectionAcceptor connectionAcceptor, boolean start, java.lang.String rootDir)`	multitorrent, magnet
`Snark(I2PSnarkUtil util, java.lang.String torrent, java.lang.String ip, int user_port, StorageListener slistener, CoordinatorListener clistener, CompleteListener complistener, PeerCoordinatorSet peerCoordinatorSet, ConnectionAcceptor connectionAcceptor, boolean start, java.lang.String rootDir)`	推奨されていません。
`Snark(I2PSnarkUtil util, java.lang.String torrent, java.lang.String ip, int user_port, StorageListener slistener, CoordinatorListener clistener, CompleteListener complistener, PeerCoordinatorSet peerCoordinatorSet, ConnectionAcceptor connectionAcceptor, boolean start, java.lang.String rootDir, java.io.File baseFile)`	multitorrent

メソッドの概要

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッド	説明
`boolean`	`addComments(java.util.List<Comment> comments)`	Add to the current comment set for this torrent, creating it if it didn't previously exist.
`void`	`addMessage(java.lang.String message)`	StorageListener and CoordinatorListener callback
`java.lang.String`	`getBaseName()`
`double`	`getCheckingProgress()`	If checking is in progress, return completion 0.0 ...
`CommentSet`	`getComments()`	The current comment set for this torrent.
`long`	`getDownloaded()`
`long`	`getDownloadRate()`
`byte[]`	`getID()`
`byte[]`	`getInfoHash()`
`MetaInfo`	`getMetaInfo()`
`java.lang.String`	`getName()`
`long`	`getNeeded()`	Does not account (i.e.
`long`	`getNeededLength()`	Bytes still wanted.
`int`	`getPeerCount()`
`java.util.List<Peer>`	`getPeerList()`
`int`	`getPieceLength(int p)`
`int`	`getPieces()`
`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()`
`long`	`getTotalLength()`
`java.lang.String`	`getTrackerProblems()`	Not HTML escaped.
`int`	`getTrackerSeenPeers()`
`java.lang.String`	`getTrackerURL()`
`long`	`getUploaded()`
`long`	`getUploadRate()`
`void`	`gotMetaInfo(PeerCoordinator coordinator, MetaInfo metainfo)`	Called when the PeerCoordinator got the MetaInfo via magnet.
`boolean`	`isAllocating()`	Disk allocation (ballooning) in progress.
`boolean`	`isAutoStoppable()`
`boolean`	`isChecking()`	File checking in progress.
`boolean`	`isStarting()`	Startup in progress.
`boolean`	`isStopped()`
`boolean`	`overUpBWLimit()`	Are we currently over the upstream bandwidth limit?
`boolean`	`overUpBWLimit(long total)`	Is the total (in Bps) over the upstream bandwidth limit?
`boolean`	`overUploadLimit(int uploaders)`	Is this number of uploaders over the per-torrent limit?
`void`	`peerChange(PeerCoordinator coordinator, Peer peer)`	CoordinatorListener - this does nothing
`boolean`	`restartAcceptor()`
`void`	`setAutoStoppable(boolean yes)`
`void`	`setStarting()`	Set startup in progress.
`void`	`setTrackerProblems(java.lang.String p)`
`void`	`setTrackerSeenPeers(int p)`
`void`	`setWantedPieces(Storage storage)`	Reset the peer's wanted pieces table Call after the storage double-check fails
`void`	`shutdown()`	SnarkSnutdown 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)`	Called when all pieces in the storage have been checked.
`void`	`storageAllocated(Storage storage, long length)`	does nothing
`void`	`storageChecked(Storage storage, int num, boolean checked)`	Called when storage is being checked and the num piece of that total pieces has been checked.
`void`	`storageCompleted(Storage storage)`	Called the one time when the data is completely received and checked.
`void`	`storageCreateFile(Storage storage, java.lang.String name, long length)`	does nothing
`void`	`updatePiecePriorities()`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - PROP_MAX_CONNECTIONS
```
public static final java.lang.String PROP_MAX_CONNECTIONS
```
    max connections
    
    関連項目:
    
    定数フィールド値
  - _util
```
protected final I2PSnarkUtil _util
```
  - MIN_TOTAL_UPLOADERS
```
static final int MIN_TOTAL_UPLOADERS
```
    Maintain a configurable total uploader cap coordinatorListener
    
    関連項目:
    
    定数フィールド値
  - MAX_TOTAL_UPLOADERS
```
static final int MAX_TOTAL_UPLOADERS
```
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - Snark
```
public Snark(I2PSnarkUtil util,
             java.lang.String torrent,
             java.lang.String ip,
             int user_port,
             StorageListener slistener,
             CoordinatorListener clistener,
             CompleteListener complistener,
             PeerCoordinatorSet peerCoordinatorSet,
             ConnectionAcceptor connectionAcceptor,
             boolean start,
             java.lang.String rootDir)
```
    推奨されていません。
    
    multitorrent
    
    例外:
    
    java.lang.RuntimeException - via fatal()
  - Snark
```
public Snark(I2PSnarkUtil util,
             java.lang.String torrent,
             java.lang.String ip,
             int user_port,
             StorageListener slistener,
             CoordinatorListener clistener,
             CompleteListener complistener,
             PeerCoordinatorSet peerCoordinatorSet,
             ConnectionAcceptor connectionAcceptor,
             boolean start,
             java.lang.String rootDir,
             java.io.File baseFile)
```
    multitorrent
    
    パラメータ:
    
    baseFile - if null, use rootDir/torrentName; if non-null, use it instead
    
    例外:
    
    java.lang.RuntimeException - via fatal()
    
    導入されたバージョン:
    
    0.9.11
  - Snark
```
public Snark(I2PSnarkUtil util,
             java.lang.String torrent,
             byte[] ih,
             java.lang.String trackerURL,
             CompleteListener complistener,
             PeerCoordinatorSet peerCoordinatorSet,
             ConnectionAcceptor connectionAcceptor,
             boolean start,
             java.lang.String rootDir)
```
    multitorrent, magnet
    
    パラメータ:
    
    torrent - a fake name for now (not a file name)
    
    ih - 20-byte info hash
    
    trackerURL - may be null
    
    例外:
    
    java.lang.RuntimeException - via fatal()
    
    導入されたバージョン:
    
    0.8.4
- メソッドの詳細
  - startTorrent
```
public void startTorrent()
```
    Start up contacting peers and querying the tracker. Blocks if tunnel is not yet open.
    
    例外:
    
    java.lang.RuntimeException - via fatal()
  - 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
    
    パラメータ:
    
    fast - if true, limit the life of the unannounce threads
    
    導入されたバージョン:
    
    0.9.1
  - getName
```
public java.lang.String getName()
```
    戻り値:
    
    file name of .torrent file (should be full absolute path), or a fake name if in magnet mode.
    
    導入されたバージョン:
    
    0.8.4
  - getBaseName
```
public java.lang.String getBaseName()
```
    戻り値:
    
    base name of torrent [filtered version of getMetaInfo.getName()], or a fake name if in magnet mode
    
    導入されたバージョン:
    
    0.8.4
  - getID
```
public byte[] getID()
```
    戻り値:
    
    always will be valid even in magnet mode
    
    導入されたバージョン:
    
    0.8.4
  - getInfoHash
```
public byte[] getInfoHash()
```
    戻り値:
    
    always will be valid even in magnet mode
    
    導入されたバージョン:
    
    0.8.4
  - getMetaInfo
```
public MetaInfo getMetaInfo()
```
    戻り値:
    
    may be null if in magnet mode
    
    導入されたバージョン:
    
    0.8.4
  - getStorage
```
public Storage getStorage()
```
    戻り値:
    
    may be null if in magnet mode
    
    導入されたバージョン:
    
    0.8.4
  - isStopped
```
public boolean isStopped()
```
    導入されたバージョン:
    
    0.8.4
  - isStarting
```
public boolean isStarting()
```
    Startup in progress.
    
    導入されたバージョン:
    
    0.9.1
  - setStarting
```
public void setStarting()
```
    Set startup in progress.
    
    導入されたバージョン:
    
    0.9.1
  - isChecking
```
public boolean isChecking()
```
    File checking in progress.
    
    導入されたバージョン:
    
    0.9.3
  - getCheckingProgress
```
public double getCheckingProgress()
```
    If checking is in progress, return completion 0.0 ... 1.0, else return 1.0.
    
    導入されたバージョン:
    
    0.9.23
  - isAllocating
```
public boolean isAllocating()
```
    Disk allocation (ballooning) in progress.
    
    導入されたバージョン:
    
    0.9.3
  - getDownloadRate
```
public long getDownloadRate()
```
    導入されたバージョン:
    
    0.8.4
  - getUploadRate
```
public long getUploadRate()
```
    導入されたバージョン:
    
    0.8.4
  - getDownloaded
```
public long getDownloaded()
```
    導入されたバージョン:
    
    0.8.4
  - getUploaded
```
public long getUploaded()
```
    導入されたバージョン:
    
    0.8.4
  - getPeerCount
```
public int getPeerCount()
```
    導入されたバージョン:
    
    0.8.4
  - getPeerList
```
public java.util.List<Peer> getPeerList()
```
    導入されたバージョン:
    
    0.8.4
  - getTrackerProblems
```
public java.lang.String getTrackerProblems()
```
    Not HTML escaped.
    
    戻り値:
    
    String returned from tracker, or null if no error
    
    導入されたバージョン:
    
    0.8.4
  - setTrackerProblems
```
public void setTrackerProblems(java.lang.String p)
```
    パラメータ:
    
    p - tracker error string or null
    
    導入されたバージョン:
    
    0.8.4
  - getTrackerSeenPeers
```
public int getTrackerSeenPeers()
```
    戻り値:
    
    count returned from tracker
    
    導入されたバージョン:
    
    0.8.4
  - setTrackerSeenPeers
```
public void setTrackerSeenPeers(int p)
```
    導入されたバージョン:
    
    0.8.4
  - updatePiecePriorities
```
public void updatePiecePriorities()
```
    導入されたバージョン:
    
    0.8.4
  - getTotalLength
```
public long getTotalLength()
```
    戻り値:
    
    total of all torrent files, or total of metainfo file if fetching magnet, or -1
    
    導入されたバージョン:
    
    0.8.4
  - getRemainingLength
```
public long getRemainingLength()
```
    Bytes not yet in storage. Does NOT account for skipped files.
    
    戻り値:
    
    exact value. or -1 if no storage yet. getNeeded() * pieceLength(0) isn't accurate if last piece is still needed.
    
    導入されたバージョン:
    
    0.8.9
  - getNeededLength
```
public long getNeededLength()
```
    Bytes still wanted. DOES account for (i.e. does not include) skipped files. FIXME -1 when not running.
    
    戻り値:
    
    exact value. or -1 if no storage yet or when not running.
    
    導入されたバージョン:
    
    0.9.1
  - 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.
    
    戻り値:
    
    exact value. or 0 if no storage yet.
    
    導入されたバージョン:
    
    0.9.24
  - getNeeded
```
public long getNeeded()
```
    Does not account (i.e. includes) for skipped files.
    
    戻り値:
    
    number of pieces still needed (magnet mode or not), or -1 if unknown
    
    導入されたバージョン:
    
    0.8.4
  - getPieceLength
```
public int getPieceLength(int p)
```
    パラメータ:
    
    p - the piece number
    
    戻り値:
    
    metainfo piece length or 16K if fetching magnet
    
    導入されたバージョン:
    
    0.8.4
  - getPieces
```
public int getPieces()
```
    戻り値:
    
    number of pieces
    
    導入されたバージョン:
    
    0.8.4
  - restartAcceptor
```
public boolean restartAcceptor()
```
    戻り値:
    
    true if restarted
    
    導入されたバージョン:
    
    0.8.4
  - getTrackerURL
```
public java.lang.String getTrackerURL()
```
    戻り値:
    
    trackerURL string from magnet-mode constructor, may be null
    
    導入されたバージョン:
    
    0.8.4
  - isAutoStoppable
```
public boolean isAutoStoppable()
```
    導入されたバージョン:
    
    0.9.9
  - setAutoStoppable
```
public void setAutoStoppable(boolean yes)
```
    導入されたバージョン:
    
    0.9.9
  - peerChange
```
public void peerChange(PeerCoordinator coordinator,
                       Peer peer)
```
    CoordinatorListener - this does nothing
    
    定義:
    
    peerChange インタフェース内 CoordinatorListener
  - 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.
    
    定義:
    
    gotMetaInfo インタフェース内 CoordinatorListener
    
    例外:
    
    java.lang.RuntimeException - via fatal()
    
    導入されたバージョン:
    
    0.8.4
  - storageCreateFile
```
public void storageCreateFile(Storage storage,
                              java.lang.String name,
                              long length)
```
    does nothing
    
    定義:
    
    storageCreateFile インタフェース内 StorageListener
  - storageAllocated
```
public void storageAllocated(Storage storage,
                             long length)
```
    does nothing
    
    定義:
    
    storageAllocated インタフェース内 StorageListener
  - storageChecked
```
public void storageChecked(Storage storage,
                           int num,
                           boolean checked)
```
    インタフェースからコピーされた説明: StorageListener
    
    Called when storage is being checked and the num piece of that total pieces has been checked. When the piece hash matches the expected piece hash checked will be true, otherwise it will be false.
    
    定義:
    
    storageChecked インタフェース内 StorageListener
  - storageAllChecked
```
public void storageAllChecked(Storage storage)
```
    インタフェースからコピーされた説明: StorageListener
    
    Called when all pieces in the storage have been checked. Does not mean that the storage is complete, just that the state of the storage is known.
    
    定義:
    
    storageAllChecked インタフェース内 StorageListener
  - storageCompleted
```
public void storageCompleted(Storage storage)
```
    インタフェースからコピーされた説明: StorageListener
    
    Called the one time when the data is completely received and checked.
    
    定義:
    
    storageCompleted インタフェース内 StorageListener
  - setWantedPieces
```
public void setWantedPieces(Storage storage)
```
    インタフェースからコピーされた説明: StorageListener
    
    Reset the peer's wanted pieces table Call after the storage double-check fails
    
    定義:
    
    setWantedPieces インタフェース内 StorageListener
  - shutdown
```
public void shutdown()
```
    SnarkSnutdown callback unused
    
    定義:
    
    shutdown インタフェース内 ShutdownListener
  - addMessage
```
public void addMessage(java.lang.String message)
```
    StorageListener and CoordinatorListener callback
    
    定義:
    
    addMessage インタフェース内 CoordinatorListener
    
    定義:
    
    addMessage インタフェース内 StorageListener
    
    導入されたバージョン:
    
    0.9.2
  - overUploadLimit
```
public boolean overUploadLimit(int uploaders)
```
    インタフェースからコピーされた説明: CoordinatorListener
    
    Is this number of uploaders over the per-torrent limit?
    
    定義:
    
    overUploadLimit インタフェース内 CoordinatorListener
  - overUpBWLimit
```
public boolean overUpBWLimit()
```
    インタフェースからコピーされた説明: CoordinatorListener
    
    Are we currently over the upstream bandwidth limit?
    
    定義:
    
    overUpBWLimit インタフェース内 CoordinatorListener
  - overUpBWLimit
```
public boolean overUpBWLimit(long total)
```
    インタフェースからコピーされた説明: CoordinatorListener
    
    Is the total (in Bps) over the upstream bandwidth limit?
    
    定義:
    
    overUpBWLimit インタフェース内 CoordinatorListener
  - getRPCID
```
public int getRPCID()
```
    A unique ID for this torrent, useful for RPC
    
    戻り値:
    
    positive value unless you wrap around
    
    導入されたバージョン:
    
    0.9.30
  - getStartedTime
```
public long getStartedTime()
```
    When did we start this torrent For RPC
    
    戻り値:
    
    0 if not started before. Not cleared when stopped.
    
    導入されたバージョン:
    
    0.9.30
  - getComments
```
public CommentSet getComments()
```
    The current comment set for this torrent. Not a copy. Caller MUST synch on the returned object for all operations.
    
    戻り値:
    
    may be null if none
    
    導入されたバージョン:
    
    0.9.31
  - addComments
```
public boolean addComments(java.util.List<Comment> comments)
```
    Add to the current comment set for this torrent, creating it if it didn't previously exist.
    
    戻り値:
    
    true if the set changed
    
    導入されたバージョン:
    
    0.9.31

クラス Snark

フィールドの概要

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

PROP_MAX_CONNECTIONS

_util

MIN_TOTAL_UPLOADERS

MAX_TOTAL_UPLOADERS

コンストラクタの詳細

Snark

Snark

Snark

メソッドの詳細

startTorrent

stopTorrent

stopTorrent

getName

getBaseName

getID

getInfoHash

getMetaInfo

getStorage

isStopped

isStarting

setStarting

isChecking

getCheckingProgress

isAllocating

getDownloadRate

getUploadRate

getDownloaded

getUploaded

getPeerCount

getPeerList

getTrackerProblems

setTrackerProblems

getTrackerSeenPeers

setTrackerSeenPeers

updatePiecePriorities

getTotalLength

getRemainingLength

getNeededLength

getSkippedLength

getNeeded

getPieceLength

getPieces

restartAcceptor

getTrackerURL

isAutoStoppable

setAutoStoppable

peerChange

gotMetaInfo

storageCreateFile

storageAllocated

storageChecked

storageAllChecked

storageCompleted

setWantedPieces

shutdown

addMessage

overUploadLimit

overUpBWLimit

overUpBWLimit

getRPCID

getStartedTime

getComments

addComments