Method Details

• connected

  void connected(Peer peer)

  Called when the connection to the peer has started and the handshake was successful.

  Parameters:

  peer - the Peer that just got connected.

• disconnected

  void disconnected(Peer peer)

  Called when the connection to the peer was terminated or the connection handshake failed.

  Parameters:

  peer - the Peer that just got disconnected.

• gotChoke

  void gotChoke(Peer peer, boolean choke)

  Called when a choke message is received.

  Parameters:

  peer - the Peer that got the message.

  choke - true when the peer got a choke message, false when the peer got an unchoke message.

• gotInterest

  void gotInterest(Peer peer, boolean interest)

  Called when an interested message is received.

  Parameters:

  peer - the Peer that got the message.

  interest - true when the peer got a interested message, false when the peer got an uninterested message.

• gotHave

  boolean gotHave(Peer peer, int piece)

  Called when a have piece message is received. If the method returns true and the peer has not yet received a interested message or we indicated earlier to be not interested then an interested message will be send.

  Parameters:

  peer - the Peer that got the message.

  piece - the piece number that the per just got.

  Returns:

  true when it is a piece that we want, false if the piece is already known.

• gotBitField

  boolean gotBitField(Peer peer, BitField bitfield)

  Called when a bitmap message is received. If this method returns true a interested message will be send back to the peer.

  Parameters:

  peer - the Peer that got the message.

  bitfield - a BitField containing the pieces that the other side has.

  Returns:

  true when the BitField contains pieces we want, false if the piece is already known.

• gotPiece

  boolean gotPiece(Peer peer, PartialPiece piece)

  Called when a piece is received from the peer. The piece must be requested by Peer.request() first. If this method returns false that means the Peer provided a corrupted piece and the connection will be closed.

  Parameters:

  peer - the Peer that got the piece.

  piece - the piece received.

  Returns:

  true when the bytes represent the piece, false otherwise.

• gotRequest

  ByteArray gotRequest(Peer peer, int piece, int off, int len)

  Called when the peer wants (part of) a piece from us. Only called when the peer is not choked by us (peer.choke(false) was called).

  Parameters:

  peer - the Peer that wants the piece.

  piece - the piece number requested.

  off - byte offset into the piece.

  len - length of the chunk requested.

  Returns:

  a byte array containing the piece or null when the piece is not available (which is a protocol error).

• needPiece

  boolean needPiece(Peer peer, BitField bitfield)

  Called when we are downloading from the peer and may need to ask for a new piece. Returns true if wantPiece() or getPartialPiece() would return a piece.

  Parameters:

  peer - the Peer that will be asked to provide the piece.

  bitfield - a BitField containing the pieces that the other side has.

  Returns:

  if we want any of what the peer has

• savePartialPieces

  void savePartialPieces(Peer peer, List<Request> pcs)

  Called when the peer has disconnected and the peer task may have a partially downloaded piece that the PeerCoordinator can save.

  Parameters:

  peer - the peer that just disconnected

  pcs - the still-outstanding piece requests whose partial data can be salvaged

• getPartialPiece

  PartialPiece getPartialPiece(Peer peer, BitField havePieces)

  Called when a peer has connected and there may be a partially downloaded piece that the coordinatorator can give the peer task.

  Parameters:

  peer - the peer that just connected

  havePieces - the have-pieces bitmask for the peer

  Returns:

  request (contains the partial data and valid length)

• getPartialPiece

  PartialPiece getPartialPiece(Peer peer, BitField havePieces, Set<Integer> allowed)

  Called when a peer has connected and there may be a partially downloaded piece that the coordinator can give the peer task. May be called while the peer chokes us, to request a BEP 6 allowed fast piece.

  Parameters:

  peer - the peer that just connected

  havePieces - the have-pieces bitmask for the peer

  allowed - the pieces servable while choked, or null for no restriction

  Returns:

  request (contains the partial data and valid length)

• getPartialPiece

  PartialPiece getPartialPiece(Peer peer, int piece)

  Called when the peer suggests a specific piece via a BEP 6 suggest message. Returns a PartialPiece for that piece if we want it and it is not already being fetched from another peer, null otherwise.

  Parameters:

  peer - the Peer that got the message.

  piece - the suggested piece number

  Returns:

  request (contains the partial data and valid length), or null if not wanted

• gotExtension

  void gotExtension(Peer peer, int id, byte[] bs)

  Called when an extension message is received.

  Parameters:

  peer - the Peer that got the message.

  id - the message ID

  bs - the message payload

• gotPort

  void gotPort(Peer peer, int port, int rport)

  Called when a DHT port message is received.

  Parameters:

  peer - the Peer that got the message.

  port - the query port

  rport - the response port

• gotPeers

  void gotPeers(Peer peer, List<PeerID> pIDList)

  Called when peers are received via PEX.

  Parameters:

  peer - the Peer that got the message.

  pIDList - the peer IDs (dest hashes)

• getUtil

  I2PSnarkUtil getUtil()

  Retrieves the shared torrent utility.

  Returns:

  the shared I2PSnarkUtil for this torrent, used to reach the context and the peer banning and comment settings

• gotCommentReq

  void gotCommentReq(Peer peer, int num)

  Called when comments are requested via ut_comment.

  Parameters:

  peer - the Peer that got the message.

  num - the number of comments asked for

• gotComments

  void gotComments(Peer peer, List<Comment> comments)

  Called when comments are received via ut_comment.

  Parameters:

  peer - the Peer that got the message.

  comments - the comments carried by the message

• isBanned

  boolean isBanned(Hash h)

  Is the given hash banned?

  Parameters:

  h - the torrent's info hash, checked against the ban list

  Returns:

  true if banned

• ban

  void ban(Hash h)

  Ban the given hash.

  Parameters:

  h - the torrent's info hash to add to the ban list