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

java.lang.Object
- org.klomp.snark.Peer
- - org.klomp.snark.WebPeer

All Implemented Interfaces:
Comparable<Peer>, EepGet.StatusListener, BandwidthListener
```
class WebPeer
extends Peer
implements EepGet.StatusListener
```
BEP 19. Does not have an associated PeerState. All request tracking is done here.

Field Summary
Fields
Modifier and Type Field and Description
static byte[] IDBytes
IDBytes.
- Fields inherited from class org.klomp.snark.Peer
  _log, CHECK_PERIOD, magnetState, metainfo, RATE_DEPTH, state

Fields
Modifier and Type	Field and Description
`static byte[]`	`IDBytes` IDBytes.

Constructor Summary
Constructors
Constructor and Description
WebPeer(PeerCoordinator coord, URI uri, PeerID peerID, MetaInfo metainfo)
Outgoing connection.

Constructors
Constructor and Description
`WebPeer(PeerCoordinator coord, URI uri, PeerID peerID, MetaInfo metainfo)` Outgoing connection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attemptFailed(String url, long bytesTransferred, long bytesRemaining, int currentAttempt, int numRetries, Exception cause)` Attempt failed notification.
`void`	`attempting(String url)` Called when a new attempt to fetch the URL is starting.
`void`	`bytesTransferred(long alreadyTransferred, int currentWrite, long bytesTransferred, long bytesRemaining, String url)` Total length should be == alreadyTransferred + currentWrite + bytesRemaining for all calls.
`(package private) void`	`cancel(int piece)` Tell the other side that we are no longer interested in any of the outstanding requests (if any) for this piece.
`int`	`completed()` completed.
`(package private) void`	`disconnect()` Disconnects this peer, closing the socket and cleaning up state.
`void`	`downloaded(int size)` Increments the download counter for this peer.
`boolean`	`equals(Object o)` Two Peers are equal when they have the same PeerID.
`long`	`getInactiveTime()` Returns the time in milliseconds since the last activity on either the incoming or outgoing connection.
`long`	`getMaxInactiveTime()`
`int`	`getMaxPipeline()` Returns the maximum request pipeline depth negotiated with the peer.
`String`	`getSocket()`
`int`	`hashCode()` The hash code of a Peer is the hash code of the peerID.
`void`	`have(int piece)` have.
`void`	`headerReceived(String url, int attemptNum, String key, String val)` Note: Headers are not processed, and this is not called, for most error response codes, unless setWriteErrorToOutput() is called before fetch().
`boolean`	`isChoked()` Whether or not the peer choked us.
`boolean`	`isChoking()` Whether or not we are choking the peer.
`boolean`	`isCompleted()` Return if a peer is a seeder.
`boolean`	`isConnected()` Returns whether the peer is in active communication.
`boolean`	`isInterested()` Whether or not the peer is interested in pieces we have.
`boolean`	`isInteresting()` Whether or not the peer has pieces we want from it.
`boolean`	`isWebPeer()` Returns whether this is a web peer.
`void`	`keepAlive()` keepAlive.
`(package private) void`	`request()` Update the request queue.
`void`	`retransmitRequests()` retransmitRequests.
`void`	`runConnection(I2PSnarkUtil util, PeerListener listener, BandwidthListener bwl, BitField ignore, MagnetState mState, boolean uploadOnly)` Runs the connection to the other peer.
`void`	`setChoking(boolean choke)` setChoking.
`boolean`	`shouldRequest(int size)` Should we request this many bytes?
`String`	`toString()` toString.
`void`	`transferComplete(long alreadyTransferred, long bytesTransferred, long bytesRemaining, String url, String outputFile, boolean notModified)` Transfer complete notification.
`void`	`transferFailed(String url, long bytesTransferred, long bytesRemaining, int currentAttempt)` Transfer failed notification.

Methods inherited from class org.klomp.snark.Peer
compareTo, disconnect, getDestination, getDownBWLimit, getDownloaded, getDownloadRate, getHandshakeMap, getMagnetState, getPeerID, getPexLastSent, getTotalCommentsSent, getUpBWLimit, getUploaded, getUploadRate, getWhenConnected, isIncoming, overDownBWLimit, overUpBWLimit, sendExtension, setHandshakeMap, setMetaInfo, setPexLastSent, setRateHistory, setTotalCommentsSent, shouldRequest, shouldSend, supportsFast, uploaded

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

- Field Detail
  - IDBytes
```
public static final byte[] IDBytes
```
    IDBytes.
- Constructor Detail
  - WebPeer
```
public WebPeer(PeerCoordinator coord,
               URI uri,
               PeerID peerID,
               MetaInfo metainfo)
```
    Outgoing connection. Creates a disconnected peer given a PeerID, your own id and the relevant MetaInfo.
    Parameters:
    uri - must be http with .i2p host
    metainfo - non-null
- Method Detail
  - attemptFailed
```
public void attemptFailed(String url,
                          long bytesTransferred,
                          long bytesRemaining,
                          int currentAttempt,
                          int numRetries,
                          Exception cause)
```
    Attempt failed notification.
    Specified by:
    attemptFailed in interface EepGet.StatusListener
    Parameters:
    url - the URL
    bytesTransferred - total transferred
    bytesRemaining - remaining
    currentAttempt - attempt index
    numRetries - retry limit
    cause - failure cause
    See Also:
    EepGet.StatusListener.bytesTransferred(long, int, long, long, java.lang.String)
  - attempting
```
public void attempting(String url)
```
    Called when a new attempt to fetch the URL is starting.
    Specified by:
    attempting in interface EepGet.StatusListener
    Parameters:
    url - the URL being attempted
  - bytesTransferred
```
public void bytesTransferred(long alreadyTransferred,
                             int currentWrite,
                             long bytesTransferred,
                             long bytesRemaining,
                             String url)
```
    Total length should be == alreadyTransferred + currentWrite + bytesRemaining for all calls.
    Specified by:
    bytesTransferred in interface EepGet.StatusListener
    Parameters:
    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
    url - the URL being fetched
  - cancel
```
void cancel(int piece)
```
    Description copied from class: Peer
    Tell the other side that we are no longer interested in any of the outstanding requests (if any) for this piece.
    Overrides:
    cancel in class Peer
    Parameters:
    piece - the piece index
  - completed
```
public int completed()
```
    completed.
    Overrides:
    completed in class Peer
    Returns:
    number of completed pieces (not bytes)
  - disconnect
```
void disconnect()
```
    Description copied from class: Peer
    Disconnects this peer, closing the socket and cleaning up state. Partial pieces are returned if deregister is true.
    Overrides:
    disconnect in class Peer
  - downloaded
```
public void downloaded(int size)
```
    Increments the download counter for this peer.
    Specified by:
    downloaded in interface BandwidthListener
    Overrides:
    downloaded in class Peer
    Parameters:
    size - the number of bytes downloaded
  - equals
```
public boolean equals(Object o)
```
    Two Peers are equal when they have the same PeerID. All other properties are ignored.
    Overrides:
    equals in class Peer
  - getInactiveTime
```
public long getInactiveTime()
```
    Description copied from class: Peer
    Returns the time in milliseconds since the last activity on either the incoming or outgoing connection.
    Overrides:
    getInactiveTime in class Peer
    Returns:
    the inactive time
  - getMaxInactiveTime
```
public long getMaxInactiveTime()
```
    Overrides:
    getMaxInactiveTime in class Peer
    Returns:
    the max inactive time
  - getMaxPipeline
```
public int getMaxPipeline()
```
    Description copied from class: Peer
    Returns the maximum request pipeline depth negotiated with the peer.
    Overrides:
    getMaxPipeline in class Peer
    Returns:
    the max pipeline
  - getSocket
```
public String getSocket()
```
    Overrides:
    getSocket in class Peer
    Returns:
    socket debug string (for debug printing)
  - hashCode
```
public int hashCode()
```
    The hash code of a Peer is the hash code of the peerID.
    Overrides:
    hashCode in class Peer
  - have
```
public void have(int piece)
```
    have.
    Overrides:
    have in class Peer
    Parameters:
    piece - the piece index
  - headerReceived
```
public void headerReceived(String url,
                           int attemptNum,
                           String key,
                           String val)
```
    Note: Headers are not processed, and this is not called, for most error response codes, unless setWriteErrorToOutput() is called before fetch(). To be changed?
    Specified by:
    headerReceived in interface EepGet.StatusListener
    Parameters:
    url - the URL
    attemptNum - attempt index
    key - header key
    val - header value
  - isChoked
```
public boolean isChoked()
```
    Description copied from class: Peer
    Whether or not the peer choked us.
    Overrides:
    isChoked in class Peer
    Returns:
    whether choked
  - isChoking
```
public boolean isChoking()
```
    Description copied from class: Peer
    Whether or not we are choking the peer.
    Overrides:
    isChoking in class Peer
    Returns:
    whether choking
  - isCompleted
```
public boolean isCompleted()
```
    Description copied from class: Peer
    Return if a peer is a seeder.
    Overrides:
    isCompleted in class Peer
    Returns:
    whether completed
  - isConnected
```
public boolean isConnected()
```
    Description copied from class: Peer
    Returns whether the peer is in active communication.
    Overrides:
    isConnected in class Peer
    Returns:
    whether connected
  - isInterested
```
public boolean isInterested()
```
    Description copied from class: Peer
    Whether or not the peer is interested in pieces we have.
    Overrides:
    isInterested in class Peer
    Returns:
    whether interested
  - isInteresting
```
public boolean isInteresting()
```
    Description copied from class: Peer
    Whether or not the peer has pieces we want from it.
    Overrides:
    isInteresting in class Peer
    Returns:
    whether interesting
  - isWebPeer
```
public boolean isWebPeer()
```
    Returns whether this is a web peer.
    Overrides:
    isWebPeer in class Peer
    Returns:
    false (WebPeer overrides to return false for historical reasons)
  - keepAlive
```
public void keepAlive()
```
    keepAlive.
    Overrides:
    keepAlive in class Peer
  - request
```
void request()
```
    Description copied from class: Peer
    Update the request queue. Call after adding wanted pieces.
    Overrides:
    request in class Peer
  - retransmitRequests
```
public void retransmitRequests()
```
    retransmitRequests.
    Overrides:
    retransmitRequests in class Peer
  - runConnection
```
public void runConnection(I2PSnarkUtil util,
                          PeerListener listener,
                          BandwidthListener bwl,
                          BitField ignore,
                          MagnetState mState,
                          boolean uploadOnly)
```
    Runs the connection to the other peer. This method does not return until the connection is terminated.
    Overrides:
    runConnection in class Peer
    Parameters:
    ignore - our bitfield, ignore
    uploadOnly - if we are complete with skipped files, i.e. a partial seed
  - setChoking
```
public void setChoking(boolean choke)
```
    setChoking.
    Overrides:
    setChoking in class Peer
    Parameters:
    choke - true to choke (stop uploading), false to unchoke (allow uploads)
  - shouldRequest
```
public boolean shouldRequest(int size)
```
    Should we request this many bytes?
    Overrides:
    shouldRequest in class Peer
    Returns:
    whether request
  - toString
```
public String toString()
```
    toString.
    Overrides:
    toString in class Peer
  - transferComplete
```
public void transferComplete(long alreadyTransferred,
                             long bytesTransferred,
                             long bytesRemaining,
                             String url,
                             String outputFile,
                             boolean notModified)
```
    Transfer complete notification.
    Specified by:
    transferComplete in interface EepGet.StatusListener
    Parameters:
    alreadyTransferred - total bytes transferred
    bytesTransferred - total incl headers
    bytesRemaining - remaining bytes
    url - the URL
    outputFile - null if unknown (output stream constructor)
    notModified - whether 304
    See Also:
    EepGet.StatusListener.bytesTransferred(long, int, long, long, java.lang.String)
  - transferFailed
```
public void transferFailed(String url,
                           long bytesTransferred,
                           long bytesRemaining,
                           int currentAttempt)
```
    Transfer failed notification.
    Specified by:
    transferFailed in interface EepGet.StatusListener
    Parameters:
    url - the URL
    bytesTransferred - total transferred
    bytesRemaining - remaining
    currentAttempt - attempt index
    See Also:
    EepGet.StatusListener.bytesTransferred(long, int, long, long, java.lang.String)

Class WebPeer

Field Summary

Fields inherited from class org.klomp.snark.Peer

Constructor Summary

Method Summary

Methods inherited from class org.klomp.snark.Peer

Methods inherited from class java.lang.Object

Field Detail

IDBytes

Constructor Detail

WebPeer

Method Detail

attemptFailed

attempting

bytesTransferred

cancel

completed

disconnect

downloaded

equals

getInactiveTime

getMaxInactiveTime

getMaxPipeline

getSocket

hashCode

have

headerReceived

isChoked

isChoking

isCompleted

isConnected

isInterested

isInteresting

isWebPeer

keepAlive

request

retransmitRequests

runConnection

setChoking

shouldRequest

toString

transferComplete

transferFailed