PeerConnectionOut (Javadocs [I2P+ 2.13.0+]

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

All Implemented Interfaces:
Runnable
```
class PeerConnectionOut
extends Object
implements Runnable
```
Manages outgoing BitTorrent protocol messages to a peer.
This class maintains a queue of outgoing messages and handles bandwidth limiting, message prioritization, and reliable delivery to the peer.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) long`	`lastSent` Last send time.
`(package private) static int`	`MAX_PREFETCH_INFLIGHT` Max uncompleted prefetches per connection; bounds pinned buffers to depth x 16KB.

Constructor Summary
Constructors
Constructor and Description
PeerConnectionOut(Peer peer, DataOutputStream dout)
Creates a new outgoing connection handler.

Constructors
Constructor and Description
`PeerConnectionOut(Peer peer, DataOutputStream dout)` Creates a new outgoing connection handler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`cancelRequest(int piece, int begin, int length)` Called by the PeerState when the other side doesn't want this request to be handled anymore.
`(package private) void`	`cancelRequestMessages()` Remove all Request messages from the queue.
`(package private) void`	`cancelRequestMessages(int piece)` Remove Request messages for a piece from the queue.
`void`	`disconnect()` Disconnect and close the output stream.
`(package private) boolean`	`hasPendingPiece()` Whether a PIECE message is still queued, i.e.
`(package private) Message`	`headPiece()` The first queued PIECE message in send order.
`(package private) int`	`prefetchInFlight()` Current number of uncompleted prefetch loads for this connection.
`(package private) int`	`queuedBytes()` Returns the total bytes of piece messages currently queued.
`(package private) static void`	`recordLoad(long ms)` Record a deferred-load duration.
`(package private) void`	`retransmitRequests(List<Request> requests)` Retransmit requests that haven't been received within REQ_TIMEOUT.
`void`	`run()` Pull messages from the send queue and deliver to the peer.
`(package private) void`	`sendAlive()` Queue a keepalive message if the queue is empty.
`(package private) void`	`sendAllowedFast(int piece)` Queue an allowed fast message (BEP 6).
`(package private) void`	`sendBitfield(BitField bitfield)` Queue a bitfield, have_all, or have_none message as appropriate.
`(package private) void`	`sendCancel(Request req)` Send a cancel message and remove any matching request from the queue.
`(package private) void`	`sendChoke(boolean choke)` Queue a choke or unchoke message, cancelling any pending inverse.
`(package private) void`	`sendExtension(int id, byte[] bytes)` Queue an extension message.
`(package private) void`	`sendHave(int piece)` Queue a have message for the given piece.
`(package private) void`	`sendInterest(boolean interest)` Queue an interested or not-interested message, cancelling any pending inverse.
`(package private) void`	`sendPiece(int piece, int begin, int length, DataLoader loader)` Queue a piece message with a callback to load the data from disk when required.
`(package private) void`	`sendPort(int port)` Queue a port message.
`(package private) void`	`sendReject(int piece, int begin, int length)` Queue a reject message.
`(package private) void`	`sendRequest(Request req)` Queue a request message, checking for duplicates.
`(package private) void`	`sendRequests(List<Request> requests)` Send all requests in the list.
`void`	`startup()` Start the sender thread.

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

- Field Detail
  - lastSent
```
long lastSent
```
    Last send time.
  - MAX_PREFETCH_INFLIGHT
```
static volatile int MAX_PREFETCH_INFLIGHT
```
    Max uncompleted prefetches per connection; bounds pinned buffers to depth x 16KB.
- Constructor Detail
  - PeerConnectionOut
```
public PeerConnectionOut(Peer peer,
                         DataOutputStream dout)
```
    Creates a new outgoing connection handler.
    Parameters:
    peer - the peer
    dout - the output stream to send messages on
- Method Detail
  - cancelRequest
```
void cancelRequest(int piece,
                   int begin,
                   int length)
```
    Called by the PeerState when the other side doesn't want this request to be handled anymore. Removes any pending Piece Message from our send queue. Does not send a cancel message.
    Parameters:
    piece - the piece number
    begin - the offset within the piece
    length - the length of the request
  - cancelRequestMessages
```
void cancelRequestMessages()
```
    Remove all Request messages from the queue. Does not send a cancel message.
  - cancelRequestMessages
```
void cancelRequestMessages(int piece)
```
    Remove Request messages for a piece from the queue. Does not send a cancel message.
    Parameters:
    piece - the piece index
  - disconnect
```
public void disconnect()
```
    Disconnect and close the output stream.
  - hasPendingPiece
```
boolean hasPendingPiece()
```
    Whether a PIECE message is still queued, i.e. we are actively uploading to the peer.
    Returns:
    true if any PIECE message is pending
  - headPiece
```
Message headPiece()
```
    The first queued PIECE message in send order.
    Returns:
    the oldest pending PIECE message, or null if none queued
  - prefetchInFlight
```
int prefetchInFlight()
```
    Current number of uncompleted prefetch loads for this connection.
    Returns:
    in-flight prefetch count, capped by MAX_PREFETCH_INFLIGHT
  - queuedBytes
```
int queuedBytes()
```
    Returns the total bytes of piece messages currently queued. Used by PeerState to limit pipelined requests.
    Returns:
    total queued piece bytes
  - recordLoad
```
static void recordLoad(long ms)
```
    Record a deferred-load duration. Called from both the prefetch task and the inline fallback in Message.sendMessage(DataOutputStream).
    Parameters:
    ms - load duration in milliseconds
  - retransmitRequests
```
void retransmitRequests(List<Request> requests)
```
    Retransmit requests that haven't been received within REQ_TIMEOUT.
    Parameters:
    requests - the list of outstanding requests
  - run
```
public void run()
```
    Pull messages from the send queue and deliver to the peer.
    Specified by:
    run in interface Runnable
  - sendAlive
```
void sendAlive()
```
    Queue a keepalive message if the queue is empty.
  - sendAllowedFast
```
void sendAllowedFast(int piece)
```
    Queue an allowed fast message (BEP 6).
  - sendBitfield
```
void sendBitfield(BitField bitfield)
```
    Queue a bitfield, have_all, or have_none message as appropriate.
    Parameters:
    bitfield - the bitfield to send
  - sendCancel
```
void sendCancel(Request req)
```
    Send a cancel message and remove any matching request from the queue.
    Parameters:
    req - the request to cancel
  - sendChoke
```
void sendChoke(boolean choke)
```
    Queue a choke or unchoke message, cancelling any pending inverse.
    Parameters:
    choke - true to choke, false to unchoke
  - sendExtension
```
void sendExtension(int id,
                   byte[] bytes)
```
    Queue an extension message.
  - sendHave
```
void sendHave(int piece)
```
    Queue a have message for the given piece.
    Parameters:
    piece - the piece number
  - sendInterest
```
void sendInterest(boolean interest)
```
    Queue an interested or not-interested message, cancelling any pending inverse.
    Parameters:
    interest - true for interested, false for not-interested
  - sendPiece
```
void sendPiece(int piece,
               int begin,
               int length,
               DataLoader loader)
```
    Queue a piece message with a callback to load the data from disk when required.
  - sendPort
```
void sendPort(int port)
```
    Queue a port message.
  - sendReject
```
void sendReject(int piece,
                int begin,
                int length)
```
    Queue a reject message.
  - sendRequest
```
void sendRequest(Request req)
```
    Queue a request message, checking for duplicates.
    Parameters:
    req - the request to send
  - sendRequests
```
void sendRequests(List<Request> requests)
```
    Send all requests in the list.
    Parameters:
    requests - the list of requests to send
  - startup
```
public void startup()
```
    Start the sender thread.

Class PeerConnectionOut

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lastSent

MAX_PREFETCH_INFLIGHT

Constructor Detail

PeerConnectionOut

Method Detail

cancelRequest

cancelRequestMessages

cancelRequestMessages

disconnect

hasPendingPiece

headPiece

prefetchInFlight

queuedBytes

recordLoad

retransmitRequests

run

sendAlive

sendAllowedFast

sendBitfield

sendCancel

sendChoke

sendExtension

sendHave

sendInterest

sendPiece

sendPort

sendReject

sendRequest

sendRequests

startup