WebPeer

java.lang.Object

org.klomp.snark.Peer

org.klomp.snark.WebPeer

All Implemented Interfaces:: Comparable<Peer>, EepGet.StatusListener, BandwidthListener

class WebPeerextends Peer implements EepGet.StatusListener

BEP 19. Does not have an associated PeerState. All request tracking is done here.

Field Summary
Modifier and Type
Field
Description
private final PeerCoordinator
_coordinator
The coordinator requesting the pieces.
private final URI
_uri
The HTTP URL of the web seed.
private static final int
ABSOLUTE_MAX_REQUESTS
Most requests allowed in flight, 2 MB of pieces.
private static final int
ABSOLUTE_MIN_REQUESTS
Fewest requests allowed in flight, 128 KB of pieces.
private BitField
bitfield
The pieces the seed has.
private boolean
connected
True while the connection is open.
private static final long
HEADER_TIMEOUT
Time allowed for a response header.
static final byte[]
IDBytes
The bytes identifying a BEP19 web seed, matched by the UI when it recognizes the connection.
private static final long
INACTIVITY_TIMEOUT
Idle time before the seed is dropped.
private final boolean
isMultiFile
True if the torrent has several files.
private long
lastRcvd
When the last data arrived.
private Request
lastRequest
The request most recently sent.
private PeerListener
listener
Listener notified of the peer's messages.
private final int
MAX_REQUESTS
Requests in flight we stay below.
private int
maxRequests
Requests allowed in flight at once.
private final int
MIN_REQUESTS
Requests in flight we aim to keep at least.
private final List<Request>
outstandingRequests
The requests from the coordinator awaiting their responses.
private static final long
TARGET_FETCH_TIME
Time a piece should be fetched within.
private Thread
thread
The thread reading from the seed.
private static final long
TOTAL_TIMEOUT
Total time allowed for one request.
private static final byte[]
ZERO_BUFFER
BEP 47: zeros for serving padding ranges, written in blocks.
Fields inherited from class Peer
_log, CHECK_PERIOD, infohash, magnetState, metainfo, RATE_DEPTH, state
Modifier and Type
Field
Description
protected final Log
_log
Logger for this peer instance.
(package private) static final long
CHECK_PERIOD
How often to recompute upload slots and UI download speeds.
protected final byte[]
infohash
SHA-1 of this torrent's info dictionary, sent in the handshake and checked against the remote copy.
(package private) MagnetState
magnetState
Shared across all peers on this torrent.
protected MetaInfo
metainfo
Will start out null in magnet mode.
(package private) static final int
RATE_DEPTH
Number of samples in the upload/download rate windows.
(package private) PeerState
state
` Keeps state for in/out connections.
Constructor Summary
Constructors
Constructor
Description
WebPeer(PeerCoordinator coord, URI uri, PeerID peerID, MetaInfo metainfo)
Outgoing connection.
Method Summary
Modifier and Type
Method
Description
private void
addRequest()
Add requests for outstanding pieces, implementing part of PeerState.
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)
This EepGet status listener helps maintain the state for the web page.
(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()
Handle a completed message.
(package private) void
disconnect()
Disconnects this peer, closing the socket and cleaning up state.
void
downloaded(int size)
BandwidthListener interface - increments the download counter for this peer.
boolean
equals(Object o)
Two Peers are equal when they have the same PeerID.
private void
fail(String url, int resp)
Handle a failed fetch, banning the webseed if appropriate.
long
getInactiveTime()
The inactive time.
private Request
getLowestOutstandingRequest(int piece)
Returns the request with the lowest offset for the given piece.
long
getMaxInactiveTime()
The max inactive time.
int
getMaxPipeline()
The max pipeline.
private Set<Integer>
getRequestedPieces()
Returns all pieces we are currently requesting.
String
getSocket()
Socket debug string, for debug printing.
int
hashCode()
The hash code of a Peer is the hash code of the peerID.
void
have(int piece)
Handle a have message.
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 EepGet.setWriteErrorToOutput() is called before fetch().
boolean
isChoked()
Whether we are choked.
boolean
isChoking()
Whether we are choking.
boolean
isCompleted()
Whether the peer completed the torrent.
boolean
isConnected()
Whether the peer is connected.
boolean
isInterested()
Whether we are interested.
boolean
isInteresting()
Whether the peer is interesting.
boolean
isWebPeer()
Returns whether this is a web peer.
void
keepAlive()
Handle a keep-alive message.
(package private) void
request()
Update the request queue.
private boolean
requestNextPiece()
Starts requesting first chunk of next piece.
void
retransmitRequests()
Retransmit pending requests.
private List<Request>
returnPartialPieces()
Return partial pieces to the coordinator.
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)
Handle a choke or unchoke message.
boolean
shouldRequest(int size)
Should we request this many bytes?
String
toString()
String form of the web peer.
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 Peer
addDontHave, compareTo, disconnect, dontHave, getDestination, getDownBWLimit, getDownloaded, getDownloadRate, getHandshakeMap, getI2PSocket, getMagnetState, getPeerID, getPexLastSent, getTotalCommentsSent, getUpBWLimit, getUploaded, getUploadRate, getWhenConnected, isIncoming, isSnubbing, isUploadOnly, overDownBWLimit, overUpBWLimit, sendExtension, setHandshakeMap, setMetaInfo, setPexLastSent, setRateHistory, setTotalCommentsSent, setUploadOnly, shouldRequest, shouldSend, supportsFast, uploaded
Modifier and Type
Method
Description
void
addDontHave(int piece)
Remember that this peer said it no longer has the piece (BEP 54 dont_have), so it is not re-requested from this peer until the remembered state expires, even if it re-announces HAVE.
int
compareTo(Peer p)
Compares this peer to another by PeerID, then by internal ID.
void
disconnect(boolean deregister)
Disconnects this peer if it was connected.
boolean
dontHave(int piece)
Whether this peer recently said it does not have the piece (BEP 54 dont_have).
Destination
getDestination()
Returns the I2P destination of the connected peer.
long
getDownBWLimit()
Current limit in Bps.
long
getDownloaded()
Returns the number of bytes that have been downloaded.
long
getDownloadRate()
Returns the average rate in Bps.
Map<String,BEValue>
getHandshakeMap()
Returns the extension handshake data from the peer.
(package private) I2PSocket
getI2PSocket()
The I2PSocket of this connection, or null if never connected.
MagnetState
getMagnetState()
Returns the shared magnet state across all peers on this torrent.
PeerID
getPeerID()
This peer's ID, assigned when it was created.
long
getPexLastSent()
Returns the timestamp when PEX peers were last sent to this peer.
(package private) int
getTotalCommentsSent()
Returns the total number of UT comments sent to this peer.
long
getUpBWLimit()
Current limit in Bps.
long
getUploaded()
Returns the number of bytes that have been uploaded.
long
getUploadRate()
Returns the average rate in Bps.
long
getWhenConnected()
Returns the timestamp when the handshake completed.
boolean
isIncoming()
Returns whether this is an incoming connection (initiated by the remote peer).
boolean
isSnubbing()
Whether or not the peer is snubbing us (unchoked but not requesting).
boolean
isUploadOnly()
Whether the peer declared itself a partial seed (BEP 21 upload_only).
boolean
overDownBWLimit()
Are we currently over the limit?
boolean
overUpBWLimit()
Is snark as a whole over its limit?
void
sendExtension(int type, byte[] payload)
Sends a protocol extension message to the peer.
void
setHandshakeMap(Map<String,BEValue> map)
Store the extension handshake data and update the request pipeline limit.
void
setMetaInfo(MetaInfo meta)
Switches from magnet mode to normal mode with metainfo.
void
setPexLastSent(long now)
Store the timestamp when PEX peers were last sent to this peer.
(package private) void
setRateHistory()
Push the total uploaded/downloaded onto a RATE_DEPTH deep stack.
(package private) void
setTotalCommentsSent(int count)
Store the total number of UT comments sent to this peer.
void
setUploadOnly(boolean uploadOnly)
The peer declared itself a partial seed (BEP 21 upload_only).
boolean
shouldRequest(Peer peer, int size)
Should we request this many bytes? Only true for this peer, which is how a callback that was handed one peer is prevented from answering for another.
boolean
shouldSend(int size)
Should we send this many bytes? Do NOT call Peer.uploaded after this.
boolean
supportsFast()
Returns whether the peer supports the FAST protocol extension (BEP 6).
void
uploaded(int size)
Increments the upload counter for this peer.
Methods inherited from class Object
clone, getClass, notify, notifyAll, wait, wait, wait

Field Details
- _coordinator
  private final PeerCoordinator _coordinator
  The coordinator requesting the pieces.
- _uri
  private final URI _uri
  The HTTP URL of the web seed.
- outstandingRequests
  private final List<Request> outstandingRequests
  The requests from the coordinator awaiting their responses.
- isMultiFile
  private final boolean isMultiFile
  True if the torrent has several files.
- lastRequest
  private Request lastRequest
  The request most recently sent.
- listener
  private PeerListener listener
  Listener notified of the peer's messages.
- bitfield
  private BitField bitfield
  The pieces the seed has.
- thread
  private Thread thread
  The thread reading from the seed.
- connected
  private boolean connected
  True while the connection is open.
- lastRcvd
  private long lastRcvd
  When the last data arrived.
- maxRequests
  private int maxRequests
  Requests allowed in flight at once.
- IDBytes
  public static final byte[] IDBytes
  The bytes identifying a BEP19 web seed, matched by the UI when it recognizes the connection.
- HEADER_TIMEOUT
  private static final long HEADER_TIMEOUT
  Time allowed for a response header.
  See Also:
  Constant Field Values
- TOTAL_TIMEOUT
  private static final long TOTAL_TIMEOUT
  Total time allowed for one request.
  See Also:
  Constant Field Values
- INACTIVITY_TIMEOUT
  private static final long INACTIVITY_TIMEOUT
  Idle time before the seed is dropped.
  See Also:
  Constant Field Values
- TARGET_FETCH_TIME
  private static final long TARGET_FETCH_TIME
  Time a piece should be fetched within.
  See Also:
  Constant Field Values
- ZERO_BUFFER
  private static final byte[] ZERO_BUFFER
  BEP 47: zeros for serving padding ranges, written in blocks.
- ABSOLUTE_MIN_REQUESTS
  private static final int ABSOLUTE_MIN_REQUESTS
  Fewest requests allowed in flight, 128 KB of pieces.
  See Also:
  Constant Field Values
- ABSOLUTE_MAX_REQUESTS
  private static final int ABSOLUTE_MAX_REQUESTS
  Most requests allowed in flight, 2 MB of pieces.
  See Also:
  Constant Field Values
- MIN_REQUESTS
  private final int MIN_REQUESTS
  Requests in flight we aim to keep at least.
- MAX_REQUESTS
  private final int MAX_REQUESTS
  Requests in flight we stay below.
Constructor Details
- 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:
  coord - the coordinator that owns this web seed connection
  uri - must be http with .i2p host
  peerID - the 20-byte peer id this seed publishes
  metainfo - non-null
Method Details
- toString
  public String toString()
  String form of the web peer.
  Overrides:
  toString in class Peer
- getSocket
  public String getSocket()
  Socket debug string, for debug printing.
  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
- 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
- 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:
  util - the utility holding this client's connection settings
  listener - notified when the connection is established or ends
  bwl - the bandwidth limiter this peer's traffic is accounted against
  ignore - our bitfield, ignore
  mState - the magnet state recording this peer's piece availability
  uploadOnly - if we are complete with skipped files, i.e. a partial seed
- fail
  private void fail(String url, int resp)
  Handle a failed fetch, banning the webseed if appropriate.
  Parameters:
  url - the URL that failed
  resp - the HTTP response code
- getMaxPipeline
  public int getMaxPipeline()
  The max pipeline.
  Overrides:
  getMaxPipeline in class Peer
  Returns:
  maximum concurrent piece requests to this peer
- isConnected
  public boolean isConnected()
  Whether the peer is connected.
  Overrides:
  isConnected in class Peer
  Returns:
  true if the connection to this peer is still up
- 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
- have
  public void have(int piece)
  Handle a have message.
  Overrides:
  have in class Peer
  Parameters:
  piece - the piece index
- 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
- request
  void request()
  Description copied from class: Peer
  Update the request queue. Call after adding wanted pieces.
  Overrides:
  request in class Peer
- isInterested
  public boolean isInterested()
  Whether we are interested.
  Overrides:
  isInterested in class Peer
  Returns:
  false always; a web seed publishes no bitfield
- isInteresting
  public boolean isInteresting()
  Whether the peer is interesting.
  Overrides:
  isInteresting in class Peer
  Returns:
  true if we want anything more from this peer
- setChoking
  public void setChoking(boolean choke)
  Handle a choke or unchoke message.
  Overrides:
  setChoking in class Peer
  Parameters:
  choke - true to choke (stop uploading), false to unchoke (allow uploads)
- isChoking
  public boolean isChoking()
  Whether we are choking.
  Overrides:
  isChoking in class Peer
  Returns:
  false always; we never block a web seed
- isChoked
  public boolean isChoked()
  Whether we are choked.
  Overrides:
  isChoked in class Peer
  Returns:
  false always; choke messages are ignored
- getInactiveTime
  public long getInactiveTime()
  The inactive time.
  Overrides:
  getInactiveTime in class Peer
  Returns:
  ms since data was last received from this peer
- getMaxInactiveTime
  public long getMaxInactiveTime()
  The max inactive time.
  Overrides:
  getMaxInactiveTime in class Peer
  Returns:
  inactivity limit in ms before the peer is dropped
- keepAlive
  public void keepAlive()
  Handle a keep-alive message.
  Overrides:
  keepAlive in class Peer
- retransmitRequests
  public void retransmitRequests()
  Retransmit pending requests.
  Overrides:
  retransmitRequests in class Peer
- completed
  public int completed()
  Handle a completed message.
  Overrides:
  completed in class Peer
  Returns:
  number of completed pieces (not bytes)
- isCompleted
  public boolean isCompleted()
  Whether the peer completed the torrent.
  Overrides:
  isCompleted in class Peer
  Returns:
  true always; a web seed is finished as soon as it connects
- 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)
- downloaded
  public void downloaded(int size)
  BandwidthListener interface - increments the download counter for this peer. Counted in the coordinator as well, since super doesn't have a PeerState.
  Specified by:
  downloaded in interface BandwidthListener
  Overrides:
  downloaded in class Peer
  Parameters:
  size - the number of bytes downloaded
- shouldRequest
  public boolean shouldRequest(int size)
  Should we request this many bytes?
  Overrides:
  shouldRequest in class Peer
  Parameters:
  size - the number of bytes about to be requested
  Returns:
  true if the coordinator allows this peer to request that many bytes
- addRequest
  private void addRequest()
  Add requests for outstanding pieces, implementing part of PeerState.
- requestNextPiece
  private boolean requestNextPiece()
  Starts requesting first chunk of next piece. Returns true if something has been added to the requests, false otherwise.
  Returns:
  true if a request for the next piece, or an adopted partial piece, was queued, false if nothing was added
- getRequestedPieces
  private Set<Integer> getRequestedPieces()
  Returns all pieces we are currently requesting.
  Returns:
  set of piece numbers, or empty set
- returnPartialPieces
  private List<Request> returnPartialPieces()
  Return partial pieces to the coordinator.
  Returns:
  list of partial piece requests
- getLowestOutstandingRequest
  private Request getLowestOutstandingRequest(int piece)
  Returns the request with the lowest offset for the given piece.
  Parameters:
  piece - the piece index
  Returns:
  the lowest-offset request, or null
- bytesTransferred
  public void bytesTransferred(long alreadyTransferred, int currentWrite, long bytesTransferred, long bytesRemaining, String url)
  This EepGet status listener helps maintain the state for the web page. 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
- 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 address whose fetch attempt failed
  bytesTransferred - bytes received so far, counted across every attempt and including response headers
  bytesRemaining - bytes still owed, or -1 if unknown
  currentAttempt - zero-based index of the attempt that failed
  numRetries - total attempts this fetch is allowed
  cause - the exception that ended the attempt
  See Also:
  EepGet.StatusListener.bytesTransferred(long, int, long, long, String)
- 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 - bytes still owed by the server, or -1 if chunked encoding or no Content-Length was returned
  url - the address the transfer was reading
  outputFile - null if unknown (output stream constructor)
  notModified - whether 304
  See Also:
  EepGet.StatusListener.bytesTransferred(long, int, long, long, 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 address whose transfer failed
  bytesTransferred - bytes received so far, counted across every attempt and including response headers
  bytesRemaining - bytes still owed, or -1 if unknown
  currentAttempt - zero-based index of the attempt that failed
  See Also:
  EepGet.StatusListener.bytesTransferred(long, int, long, long, String)
- 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 EepGet.setWriteErrorToOutput() is called before fetch(). To be changed?
  Specified by:
  headerReceived in interface EepGet.StatusListener
  Parameters:
  url - the address the header arrived on
  attemptNum - zero-based index of the attempt the header arrived on
  key - header key
  val - header value
- 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

Field Summary

Fields inherited from class Peer

Constructor Summary

Method Summary

Methods inherited from class Peer

Methods inherited from class Object

Field Details

_coordinator

_uri

outstandingRequests

isMultiFile

lastRequest

listener

bitfield

thread

connected

lastRcvd

maxRequests

IDBytes

HEADER_TIMEOUT

TOTAL_TIMEOUT

INACTIVITY_TIMEOUT

TARGET_FETCH_TIME

ZERO_BUFFER

ABSOLUTE_MIN_REQUESTS

ABSOLUTE_MAX_REQUESTS

MIN_REQUESTS

MAX_REQUESTS

Constructor Details

Method Details

toString

getSocket

hashCode

equals

runConnection

fail

getMaxPipeline

isConnected

disconnect

have

cancel

request

isInterested

isInteresting

setChoking

isChoking

isChoked

getInactiveTime

getMaxInactiveTime

keepAlive

retransmitRequests

completed

isCompleted

isWebPeer

downloaded

shouldRequest

addRequest

requestNextPiece

getRequestedPieces

returnPartialPieces

getLowestOutstandingRequest

bytesTransferred

attemptFailed

transferComplete

transferFailed

headerReceived

attempting