freenet.io.xfer

Class BulkTransmitter

java.lang.Object

freenet.io.xfer.BulkTransmitter

public class BulkTransmitter
extends java.lang.Object

Bulk data transfer (not block). Bulk transfer is designed for files which may be much bigger than a key block, and where we have the whole file at the outset. Do not persist across node restarts. Used by update over mandatory, sending a file to our peers attached to an N2NTM etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BulkTransmitter.AllSentCallback

Constructor Summary

Constructors

Constructor and Description
BulkTransmitter(PartiallyReceivedBulk prb, PeerContext peer, long uid, boolean noWait, ByteCounter ctr, boolean realTime)
BulkTransmitter(PartiallyReceivedBulk prb, PeerContext peer, long uid, boolean noWait, ByteCounter ctr, boolean realTime, BulkTransmitter.AllSentCallback cb) Create a bulk data transmitter.

Method Summary

Modifier and Type	Method and Description
void	cancel(java.lang.String reason)
void	completed() Like cancel(), but without the negative overtones: The client says it's got everything, we believe them (even if we haven't sent everything; maybe they had a partial).
java.lang.String	getCancelReason()
void	onAborted() Called when the PRB is aborted.
boolean	send() Send the file.
java.lang.String	toString()
static long[]	transferSuccess()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BulkTransmitter

public BulkTransmitter(PartiallyReceivedBulk prb,
                       PeerContext peer,
                       long uid,
                       boolean noWait,
                       ByteCounter ctr,
                       boolean realTime)
                throws DisconnectedException

Throws:

DisconnectedException

BulkTransmitter

public BulkTransmitter(PartiallyReceivedBulk prb,
                       PeerContext peer,
                       long uid,
                       boolean noWait,
                       ByteCounter ctr,
                       boolean realTime,
                       BulkTransmitter.AllSentCallback cb)
                throws DisconnectedException

Create a bulk data transmitter.

Parameters:

prb - The PartiallyReceivedBulk containing the file we want to send, or the part of it that we have so far.

peer - The peer we want to send it to.

uid - The unique identifier for this data transfer

noWait - If true, don't wait for an FNPBulkReceivedAll, return as soon as we've sent everything.

Throws:

DisconnectedException - If the peer we are trying to send to becomes disconnected.

Method Detail

onAborted

public void onAborted()

Called when the PRB is aborted.

cancel

public void cancel(java.lang.String reason)

completed

public void completed()

Like cancel(), but without the negative overtones: The client says it's got everything, we believe them (even if we haven't sent everything; maybe they had a partial).

send

public boolean send()
             throws DisconnectedException

Send the file.

Returns:

True if the file was successfully sent. False otherwise.

Throws:

DisconnectedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCancelReason

public java.lang.String getCancelReason()

transferSuccess

public static long[] transferSuccess()