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

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

All Implemented Interfaces:
Comparable<Peer>, BandwidthListener
Direct Known Subclasses:
WebPeer
```
public class Peer
extends Object
implements Comparable<Peer>, BandwidthListener
```
Represents a peer in the BitTorrent network, managing all public information and communication with that peer.
This class handles:
- Peer identification and handshaking
- BitTorrent protocol communication
- Upload/download statistics tracking
- Connection state management
- Bandwidth monitoring and limiting
Peers can be either incoming (they connected to us) or outgoing (we connected to them) connections.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Log`	`_log` Logger for this peer instance.
`(package private) static long`	`CHECK_PERIOD` C h e c k p e r i o d
`(package private) MagnetState`	`magnetState` shared across all peers on this torrent
`protected MetaInfo`	`metainfo` will start out null in magnet mode
`(package private) static int`	`RATE_DEPTH` R a t e d e p t h
`(package private) PeerState`	`state` ` Keeps state for in/out connections.

Constructor Summary

Constructors
Constructor and Description
`Peer(I2PSocket sock, InputStream in, OutputStream out, byte[] my_id, byte[] infohash, MetaInfo metainfo)` Incoming connection.
`Peer(PeerID peerID, byte[] my_id, byte[] infohash, MetaInfo metainfo)` Outgoing connection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(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`	`compareTo(Peer p)` Compares this peer to another by PeerID, then by internal ID.
`int`	`completed()` Return how much the peer has
`(package private) void`	`disconnect()` Disconnects this peer, closing the socket and cleaning up state.
`void`	`disconnect(boolean deregister)` Disconnects this peer if it was connected.
`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.
`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.
`long`	`getInactiveTime()` Returns the time in milliseconds since the last activity on either the incoming or outgoing connection.
`MagnetState`	`getMagnetState()` Returns the shared magnet state across all peers on this torrent.
`long`	`getMaxInactiveTime()`
`int`	`getMaxPipeline()` Returns the maximum request pipeline depth negotiated with the peer.
`PeerID`	`getPeerID()` Returns the id of the peer.
`long`	`getPexLastSent()` Returns the timestamp when PEX peers were last sent to this peer.
`String`	`getSocket()`
`(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.
`int`	`hashCode()` The hash code of a Peer is the hash code of the peerID.
`void`	`have(int piece)` Notifies the peer that we have a new piece.
`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`	`isIncoming()` Returns whether this is an incoming connection (initiated by the remote peer).
`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()` Send keepalive
`boolean`	`overDownBWLimit()` Are we currently over the limit?
`boolean`	`overUpBWLimit()` Is snark as a whole over its limit?
`(package private) void`	`request()` Update the request queue.
`void`	`retransmitRequests()` Retransmit outstanding requests if necessary
`void`	`runConnection(I2PSnarkUtil util, PeerListener listener, BandwidthListener bwl, BitField bitfield, MagnetState mState, boolean uploadOnly)` Runs the connection to the other peer.
`void`	`sendExtension(int type, byte[] payload)` Sends a protocol extension message to the peer.
`void`	`setChoking(boolean choke)` Sets whether or not we are choking the peer.
`void`	`setHandshakeMap(Map<String,BEValue> map)` Sets the extension handshake data and updates the request pipeline limit.
`void`	`setMetaInfo(MetaInfo meta)` Switches from magnet mode to normal mode with metainfo.
`void`	`setPexLastSent(long now)` Sets 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)` Sets the total number of UT comments sent to this peer.
`boolean`	`shouldRequest(int size)` Should we request this many bytes?
`boolean`	`shouldRequest(Peer peer, int size)` Should we request this many bytes?
`boolean`	`shouldSend(int size)` Should we send this many bytes? Do NOT call uploaded() after this.
`boolean`	`supportsFast()` Returns whether the peer supports the FAST protocol extension (BEP 6).
`String`	`toString()` Returns the String representation of the peerID.
`void`	`uploaded(int size)` Increments the upload counter for this peer.

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

- Field Detail
  - _log
```
protected final Log _log
```
    Logger for this peer instance.
  - CHECK_PERIOD
```
static final long CHECK_PERIOD
```
    C h e c k p e r i o d
    See Also:
    Constant Field Values
  - magnetState
```
MagnetState magnetState
```
    shared across all peers on this torrent
  - metainfo
```
protected MetaInfo metainfo
```
    will start out null in magnet mode
  - RATE_DEPTH
```
static final int RATE_DEPTH
```
    R a t e d e p t h
    See Also:
    Constant Field Values
  - state
```
volatile PeerState state
```
    ` Keeps state for in/out connections. Non-null when the handshake was successful, the connection setup and runs. Do not access directly. All actions should be through Peer methods.
- Constructor Detail
  - Peer
```
public Peer(I2PSocket sock,
            InputStream in,
            OutputStream out,
            byte[] my_id,
            byte[] infohash,
            MetaInfo metainfo)
     throws IOException
```
    Incoming connection. Creates a unconnected peer from the input and output stream got from the socket. Note that the complete handshake (which can take some time or block indefinitely) is done in the calling Thread to get the remote peer id. To completely start the connection call the connect() method.
    Parameters:
    metainfo - null if in magnet mode
    Throws:
    IOException - when an error occurred during the handshake.
  - Peer
```
public Peer(PeerID peerID,
            byte[] my_id,
            byte[] infohash,
            MetaInfo metainfo)
```
    Outgoing connection. Creates a disconnected peer given a PeerID, your own id and the relevant MetaInfo.
    Parameters:
    metainfo - null if in magnet mode
- Method Detail
  - cancel
```
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.
    Parameters:
    piece - the piece index
  - compareTo
```
public int compareTo(Peer p)
```
    Compares this peer to another by PeerID, then by internal ID.
    Specified by:
    compareTo in interface Comparable<Peer>
    Parameters:
    p - the peer to compare to
    Returns:
    a negative, zero, or positive integer
  - completed
```
public int completed()
```
    Return how much the peer has
    Returns:
    number of completed pieces (not bytes)
  - disconnect
```
void disconnect()
```
    Disconnects this peer, closing the socket and cleaning up state. Partial pieces are returned if deregister is true.
  - disconnect
```
public void disconnect(boolean deregister)
```
    Disconnects this peer if it was connected. PeerListener.disconnected() will be called when the connection is completely terminated. If deregister is true, partial pieces will be returned.
    Parameters:
    deregister - true if partial pieces should be returned
  - downloaded
```
public void downloaded(int size)
```
    Increments the download counter for this peer.
    Specified by:
    downloaded in interface BandwidthListener
    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 Object
  - getDestination
```
public Destination getDestination()
```
    Returns the I2P destination of the connected peer.
    Returns:
    the peer's Destination, or null if not connected
  - getDownBWLimit
```
public long getDownBWLimit()
```
    Current limit in Bps
    Specified by:
    getDownBWLimit in interface BandwidthListener
    Returns:
    the down b w limit
  - getDownloaded
```
public long getDownloaded()
```
    Returns the number of bytes that have been downloaded. Can be reset to zero with resetCounters() which is called every CHECK_PERIOD by PeerCheckerTask.
    Returns:
    the downloaded
  - getDownloadRate
```
public long getDownloadRate()
```
    Returns the average rate in Bps.
    Specified by:
    getDownloadRate in interface BandwidthListener
    Returns:
    average download rate in bytes per second
  - getHandshakeMap
```
public Map<String,BEValue> getHandshakeMap()
```
    Returns the extension handshake data from the peer.
    Returns:
    the handshake map, or null if not yet received
  - getInactiveTime
```
public long getInactiveTime()
```
    Returns the time in milliseconds since the last activity on either the incoming or outgoing connection.
    Returns:
    inactive time in ms, or -1 if not connected
  - getMagnetState
```
public MagnetState getMagnetState()
```
    Returns the shared magnet state across all peers on this torrent. Callers must synchronize on the returned object.
    Returns:
    the magnet state (non-null)
  - getMaxInactiveTime
```
public long getMaxInactiveTime()
```
    Returns:
    max inactive time
  - getMaxPipeline
```
public int getMaxPipeline()
```
    Returns the maximum request pipeline depth negotiated with the peer.
    Returns:
    the max pipeline depth, bounded by MIN_PIPELINE and MAX_PIPELINE
  - getPeerID
```
public PeerID getPeerID()
```
    Returns the id of the peer.
  - getPexLastSent
```
public long getPexLastSent()
```
    Returns the timestamp when PEX peers were last sent to this peer.
    Returns:
    the last PEX timestamp in milliseconds
  - getSocket
```
public String getSocket()
```
    Returns:
    socket debug string (for debug printing)
  - getTotalCommentsSent
```
int getTotalCommentsSent()
```
    Returns the total number of UT comments sent to this peer.
    Returns:
    the comment count
  - getUpBWLimit
```
public long getUpBWLimit()
```
    Current limit in Bps
    Specified by:
    getUpBWLimit in interface BandwidthListener
    Returns:
    the up b w limit
  - getUploaded
```
public long getUploaded()
```
    Returns the number of bytes that have been uploaded. Can be reset to zero with resetCounters() which is called every CHECK_PERIOD by PeerCheckerTask.
    Returns:
    the uploaded
  - getUploadRate
```
public long getUploadRate()
```
    Returns the average rate in Bps.
    Specified by:
    getUploadRate in interface BandwidthListener
    Returns:
    average upload rate in bytes per second
  - getWhenConnected
```
public long getWhenConnected()
```
    Returns the timestamp when the handshake completed.
    Returns:
    the connection timestamp in milliseconds
  - hashCode
```
public int hashCode()
```
    The hash code of a Peer is the hash code of the peerID.
    Overrides:
    hashCode in class Object
  - have
```
public void have(int piece)
```
    Notifies the peer that we have a new piece.
    Parameters:
    piece - the piece index
  - isChoked
```
public boolean isChoked()
```
    Whether or not the peer choked us.
    Returns:
    true when choked or not connected
  - isChoking
```
public boolean isChoking()
```
    Whether or not we are choking the peer.
    Returns:
    true when choking or not connected
  - isCompleted
```
public boolean isCompleted()
```
    Return if a peer is a seeder.
    Returns:
    true if the peer has all pieces
  - isConnected
```
public boolean isConnected()
```
    Returns whether the peer is in active communication.
    Returns:
    true if the peer has an active PeerState
  - isIncoming
```
public boolean isIncoming()
```
    Returns whether this is an incoming connection (initiated by the remote peer).
    Returns:
    true if incoming, false if outgoing
  - isInterested
```
public boolean isInterested()
```
    Whether or not the peer is interested in pieces we have.
    Returns:
    true if interested, false if not connected
  - isInteresting
```
public boolean isInteresting()
```
    Whether or not the peer has pieces we want from it.
    Returns:
    true if interesting, false if not connected
  - isWebPeer
```
public boolean isWebPeer()
```
    Returns whether this is a web peer.
    Returns:
    false (base Peer is never a web peer)
  - keepAlive
```
public void keepAlive()
```
    Send keepalive
  - overDownBWLimit
```
public boolean overDownBWLimit()
```
    Are we currently over the limit?
    Specified by:
    overDownBWLimit in interface BandwidthListener
    Returns:
    true if over the download limit, false otherwise
  - overUpBWLimit
```
public boolean overUpBWLimit()
```
    Is snark as a whole over its limit?
    Specified by:
    overUpBWLimit in interface BandwidthListener
    Returns:
    true if over the upload limit, false otherwise
  - request
```
void request()
```
    Update the request queue. Call after adding wanted pieces.
  - retransmitRequests
```
public void retransmitRequests()
```
    Retransmit outstanding requests if necessary
  - runConnection
```
public void runConnection(I2PSnarkUtil util,
                          PeerListener listener,
                          BandwidthListener bwl,
                          BitField bitfield,
                          MagnetState mState,
                          boolean uploadOnly)
```
    Runs the connection to the other peer. This method does not return until the connection is terminated.
    When the connection is correctly started the connected() method of the given PeerListener is called. If the connection ends or the connection could not be setup correctly the disconnected() method is called.
    If the given BitField is non-null it is send to the peer as first message.
    Parameters:
    uploadOnly - if we are complete with skipped files, i.e. a partial seed
  - sendExtension
```
public void sendExtension(int type,
                          byte[] payload)
```
    Sends a protocol extension message to the peer.
    Parameters:
    type - the extension message type
    payload - the extension message payload
  - setChoking
```
public void setChoking(boolean choke)
```
    Sets whether or not we are choking the peer. Defaults to true. When choke is false and the peer requests some pieces we upload them, otherwise requests of this peer are ignored.
    Parameters:
    choke - true to choke (stop uploading), false to unchoke (allow uploads)
  - setHandshakeMap
```
public void setHandshakeMap(Map<String,BEValue> map)
```
    Sets the extension handshake data and updates the request pipeline limit.
    Parameters:
    map - the handshake map (non-null)
  - setMetaInfo
```
public void setMetaInfo(MetaInfo meta)
```
    Switches from magnet mode to normal mode with metainfo.
    Parameters:
    meta - the metainfo to set
  - setPexLastSent
```
public void setPexLastSent(long now)
```
    Sets the timestamp when PEX peers were last sent to this peer.
    Parameters:
    now - the current timestamp in milliseconds
  - setRateHistory
```
void setRateHistory()
```
    Push the total uploaded/downloaded onto a RATE_DEPTH deep stack. Resets the downloaded and uploaded counters to zero.
  - setTotalCommentsSent
```
void setTotalCommentsSent(int count)
```
    Sets the total number of UT comments sent to this peer.
    Parameters:
    count - the count to set
  - shouldRequest
```
public boolean shouldRequest(int size)
```
    Should we request this many bytes?
    Returns:
    whether request
  - shouldRequest
```
public boolean shouldRequest(Peer peer,
                             int size)
```
    Should we request this many bytes?
    Specified by:
    shouldRequest in interface BandwidthListener
    Parameters:
    peer - the peer
    size - the number of bytes to request
    Returns:
    whether request
  - shouldSend
```
public boolean shouldSend(int size)
```
    Should we send this many bytes? Do NOT call uploaded() after this.
    Specified by:
    shouldSend in interface BandwidthListener
    Parameters:
    size - the number of bytes to send
    Returns:
    whether send
  - supportsFast
```
public boolean supportsFast()
```
    Returns whether the peer supports the FAST protocol extension (BEP 6).
    Returns:
    true if FAST extension is supported
  - toString
```
public String toString()
```
    Returns the String representation of the peerID.
    Overrides:
    toString in class Object
  - uploaded
```
public void uploaded(int size)
```
    Increments the upload counter for this peer.
    Specified by:
    uploaded in interface BandwidthListener
    Parameters:
    size - the number of bytes uploaded

Class Peer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_log

CHECK_PERIOD

magnetState

metainfo

RATE_DEPTH

state

Constructor Detail

Peer

Peer

Method Detail

cancel

compareTo

completed

disconnect

disconnect

downloaded

equals

getDestination

getDownBWLimit

getDownloaded

getDownloadRate

getHandshakeMap

getInactiveTime

getMagnetState

getMaxInactiveTime

getMaxPipeline

getPeerID

getPexLastSent

getSocket

getTotalCommentsSent

getUpBWLimit

getUploaded

getUploadRate

getWhenConnected

hashCode

have

isChoked

isChoking

isCompleted

isConnected

isIncoming

isInterested

isInteresting

isWebPeer

keepAlive

overDownBWLimit

overUpBWLimit

request

retransmitRequests

runConnection

sendExtension

setChoking

setHandshakeMap

setMetaInfo

setPexLastSent

setRateHistory

setTotalCommentsSent

shouldRequest

shouldRequest

shouldSend

supportsFast

toString

uploaded