Package org.johnnei.javatorrent.torrent.files

Interface IFileSetRequestFactory

public interface IFileSetRequestFactory

The interface which defines methods to construct IMessage to invoke requests for Piece

Method Summary

Modifier and Type	Method	Description
IMessage	createCancelRequestFor(Peer peer, Piece piece, int byteOffset, int length)	Creates a cancel IMessage for a earlier send out request.
IMessage	createRequestFor(Peer peer, Piece piece, int byteOffset, int length)	Creates a request to download the given piece block.
boolean	supportsCancellation()

Method Detail

createRequestFor

IMessage createRequestFor(Peer peer,
                          Piece piece,
                          int byteOffset,
                          int length)

Creates a request to download the given piece block.

Parameters:

peer - The peer for which this request is being constructed.

piece - The piece to request.

byteOffset - The offset within the piece.

length - The length of the block to request.

Returns:

The IMessage which will request the block.

See Also:

createCancelRequestFor(Peer, Piece, int, int)

createCancelRequestFor

IMessage createCancelRequestFor(Peer peer,
                                Piece piece,
                                int byteOffset,
                                int length)

Creates a cancel IMessage for a earlier send out request.

Parameters:

peer -

piece - The piece to cancel the request for.

byteOffset - The offset within the piece.

length - The length of the block which was requested.

Returns:

The IMessage to cancel the request, or null if supportsCancellation() returns false.

See Also:

createRequestFor(Peer, Piece, int, int)

supportsCancellation

boolean supportsCancellation()

Returns:

Returns true when a request created by createRequestFor(Peer, Piece, int, int) can be cancelled.

See Also:

createCancelRequestFor(Peer, Piece, int, int)