FetchAndAdd (I2P Anonymous Network - Java Documentation

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

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

java.lang.Runnable, EepGet.StatusListener
```
public class FetchAndAdd
extends Snark
implements EepGet.StatusListener, java.lang.Runnable
```
A cancellable torrent file downloader. We extend Snark so its status may be easily listed in the web table without adding a lot of code there. Upon successful download, this Snark will be deleted and a "real" Snark created. The methods return values similar to a Snark in magnet mode. A fake info hash, which is the SHA1 of the URL, is returned to prevent duplicates. This Snark may be stopped and restarted, although a partially downloaded file is discarded.

導入されたバージョン:

0.9.1 Moved from I2PSnarkUtil

フィールドの概要
- クラスから継承されたフィールド org.klomp.snark.Snark
  _util, PROP_MAX_CONNECTIONS

コンストラクタの概要

コンストラクタ
コンストラクタ	説明
`FetchAndAdd(I2PAppContext ctx, SnarkManager mgr, java.lang.String url, java.io.File dataDir)`	Caller should call _mgr.addDownloader(this), which will start things off.

メソッドの概要

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッド	説明
`void`	`attemptFailed(java.lang.String url, long bytesTransferred, long bytesRemaining, int currentAttempt, int numRetries, java.lang.Exception cause)`
`void`	`attempting(java.lang.String url)`
`void`	`bytesTransferred(long alreadyTransferred, int currentWrite, long bytesTransferred, long bytesRemaining, java.lang.String url)`	alreadyTransferred - total of all attempts, not including currentWrite If nonzero on the first call, a partial file of that length was found, _and_ the server supports resume.
`java.lang.String`	`getBaseName()`
`long`	`getDownloaded()`
`long`	`getDownloadRate()`
`byte[]`	`getInfoHash()`
`java.lang.String`	`getName()`
`long`	`getNeededLength()`	Bytes still wanted.
`int`	`getPeerCount()`
`long`	`getRemainingLength()`	Bytes not yet in storage.
`long`	`getTotalLength()`
`int`	`getTrackerSeenPeers()`
`void`	`headerReceived(java.lang.String url, int attemptNum, java.lang.String key, java.lang.String val)`	Note: Headers are not processed, and this is not called, for most error response codes, unless setWriteErrorToOutput() is called before fetch().
`boolean`	`isStopped()`
`void`	`run()`	Set off by startTorrent()
`void`	`startTorrent()`	Start up contacting peers and querying the tracker.
`void`	`stopTorrent()`	Stop contacting the tracker and talking with peers
`void`	`transferComplete(long alreadyTransferred, long bytesTransferred, long bytesRemaining, java.lang.String url, java.lang.String outputFile, boolean notModified)`
`void`	`transferFailed(java.lang.String url, long bytesTransferred, long bytesRemaining, int currentAttempt)`

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

クラスから継承されたメソッド org.klomp.snark.Snark
addComments, addMessage, getCheckingProgress, getComments, getID, getMetaInfo, getNeeded, getPeerList, getPieceLength, getPieces, getRPCID, getSkippedLength, getStartedTime, getStorage, getTrackerProblems, getTrackerURL, getUploaded, getUploadRate, gotMetaInfo, isAllocating, isAutoStoppable, isChecking, isStarting, overUpBWLimit, overUpBWLimit, overUploadLimit, peerChange, restartAcceptor, setAutoStoppable, setStarting, setTrackerProblems, setTrackerSeenPeers, setWantedPieces, shutdown, stopTorrent, storageAllChecked, storageAllocated, storageChecked, storageCompleted, storageCreateFile, updatePiecePriorities

- コンストラクタの詳細
  - FetchAndAdd
```
public FetchAndAdd(I2PAppContext ctx,
                   SnarkManager mgr,
                   java.lang.String url,
                   java.io.File dataDir)
```
    Caller should call _mgr.addDownloader(this), which will start things off.
    
    パラメータ:
    
    dataDir - null to default to snark data directory
- メソッドの詳細
  - run
```
public void run()
```
    Set off by startTorrent()
    
    定義:
    
    run インタフェース内 java.lang.Runnable
  - startTorrent
```
public void startTorrent()
```
    クラスからコピーされた説明: Snark
    
    Start up contacting peers and querying the tracker. Blocks if tunnel is not yet open.
    
    オーバーライド:
    
    startTorrent クラス内 Snark
  - stopTorrent
```
public void stopTorrent()
```
    クラスからコピーされた説明: Snark
    
    Stop contacting the tracker and talking with peers
    
    オーバーライド:
    
    stopTorrent クラス内 Snark
  - isStopped
```
public boolean isStopped()
```
    オーバーライド:
    
    isStopped クラス内 Snark
  - getName
```
public java.lang.String getName()
```
    オーバーライド:
    
    getName クラス内 Snark
    
    戻り値:
    
    file name of .torrent file (should be full absolute path), or a fake name if in magnet mode.
  - getBaseName
```
public java.lang.String getBaseName()
```
    オーバーライド:
    
    getBaseName クラス内 Snark
    
    戻り値:
    
    base name of torrent [filtered version of getMetaInfo.getName()], or a fake name if in magnet mode
  - getInfoHash
```
public byte[] getInfoHash()
```
    オーバーライド:
    
    getInfoHash クラス内 Snark
    
    戻り値:
    
    always will be valid even in magnet mode
  - getTotalLength
```
public long getTotalLength()
```
    オーバーライド:
    
    getTotalLength クラス内 Snark
    
    戻り値:
    
    torrent file size or -1
  - getRemainingLength
```
public long getRemainingLength()
```
    クラスからコピーされた説明: Snark
    
    Bytes not yet in storage. Does NOT account for skipped files.
    
    オーバーライド:
    
    getRemainingLength クラス内 Snark
    
    戻り値:
    
    -1 when done so the web will list us as "complete" instead of "seeding"
  - getNeededLength
```
public long getNeededLength()
```
    クラスからコピーされた説明: Snark
    
    Bytes still wanted. DOES account for (i.e. does not include) skipped files. FIXME -1 when not running.
    
    オーバーライド:
    
    getNeededLength クラス内 Snark
    
    戻り値:
    
    torrent file bytes remaining or -1
  - getDownloadRate
```
public long getDownloadRate()
```
    オーバーライド:
    
    getDownloadRate クラス内 Snark
  - getDownloaded
```
public long getDownloaded()
```
    オーバーライド:
    
    getDownloaded クラス内 Snark
  - getPeerCount
```
public int getPeerCount()
```
    オーバーライド:
    
    getPeerCount クラス内 Snark
  - getTrackerSeenPeers
```
public int getTrackerSeenPeers()
```
    オーバーライド:
    
    getTrackerSeenPeers クラス内 Snark
    
    戻り値:
    
    count returned from tracker
  - attemptFailed
```
public void attemptFailed(java.lang.String url,
                          long bytesTransferred,
                          long bytesRemaining,
                          int currentAttempt,
                          int numRetries,
                          java.lang.Exception cause)
```
    定義:
    
    attemptFailed インタフェース内 EepGet.StatusListener
  - bytesTransferred
```
public void bytesTransferred(long alreadyTransferred,
                             int currentWrite,
                             long bytesTransferred,
                             long bytesRemaining,
                             java.lang.String url)
```
    インタフェースからコピーされた説明: EepGet.StatusListener
    
    alreadyTransferred - total of all attempts, not including currentWrite If nonzero on the first call, a partial file of that length was found, _and_ the server supports resume. If zero on a subsequent call after some bytes are transferred (and presumably after an attemptFailed), the server does _not_ support resume and we had to start over. To track _actual_ transfer if the output file could already exist, the listener should keep its own counter, or subtract the initial alreadyTransferred value. And watch out for alreadyTransferred resetting if a resume failed... currentWrite - since last call to the listener bytesTransferred - includes headers, retries, redirects, discarded partial downloads, ... bytesRemaining - on this attempt only, currentWrite already subtracted - or -1 if chunked encoding or server does not return a length Total length should be == alreadyTransferred + currentWrite + bytesRemaining for all calls
    
    定義:
    
    bytesTransferred インタフェース内 EepGet.StatusListener
  - transferComplete
```
public void transferComplete(long alreadyTransferred,
                             long bytesTransferred,
                             long bytesRemaining,
                             java.lang.String url,
                             java.lang.String outputFile,
                             boolean notModified)
```
    定義:
    
    transferComplete インタフェース内 EepGet.StatusListener
  - transferFailed
```
public void transferFailed(java.lang.String url,
                           long bytesTransferred,
                           long bytesRemaining,
                           int currentAttempt)
```
    定義:
    
    transferFailed インタフェース内 EepGet.StatusListener
  - headerReceived
```
public void headerReceived(java.lang.String url,
                           int attemptNum,
                           java.lang.String key,
                           java.lang.String val)
```
    インタフェースからコピーされた説明: EepGet.StatusListener
    
    Note: Headers are not processed, and this is not called, for most error response codes, unless setWriteErrorToOutput() is called before fetch(). To be changed?
    
    定義:
    
    headerReceived インタフェース内 EepGet.StatusListener
  - attempting
```
public void attempting(java.lang.String url)
```
    定義:
    
    attempting インタフェース内 EepGet.StatusListener

クラス FetchAndAdd

フィールドの概要

クラスから継承されたフィールド org.klomp.snark.Snark

コンストラクタの概要

メソッドの概要

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

クラスから継承されたメソッド org.klomp.snark.Snark

コンストラクタの詳細

FetchAndAdd

メソッドの詳細

run

startTorrent

stopTorrent

isStopped

getName

getBaseName

getInfoHash

getTotalLength

getRemainingLength

getNeededLength

getDownloadRate

getDownloaded

getPeerCount

getTrackerSeenPeers

attemptFailed

bytesTransferred

transferComplete

transferFailed

headerReceived

attempting