freenet.node

Class RequestSender

java.lang.Object

freenet.node.BaseSender

freenet.node.RequestSender

All Implemented Interfaces:

ByteCounter, PrioRunnable, java.lang.Runnable

public final class RequestSender
extends BaseSender
implements PrioRunnable

Nested Class Summary

Nested classes/interfaces inherited from class freenet.node.BaseSender

BaseSender.DO

Field Summary

Fields inherited from class freenet.node.BaseSender

dontDecrementHTLThisTime, gotMessages, hasForwarded, htl, lastMessage, lastNode, nodesRoutedTo, origHTL, rejectOverloads, routeAttempts, startTime

Constructor Summary

Constructors

Constructor and Description
RequestSender(Key key, DSAPublicKey pubKey, short htl, long uid, RequestTag tag, Node n, PeerNode source, boolean offersOnly, boolean canWriteClientCache, boolean canWriteDatastore, boolean realTimeFlag) RequestSender constructor.

Method Summary

Modifier and Type	Method and Description
boolean	abortedDownstreamTransfers()
void	addListener(RequestSenderListener l)
protected Message	createDataRequest()
long	fetchTimeout()
protected void	forwardRejectedOverload() Forward RejectedOverload to the request originator
protected long	getAcceptedTimeout()
byte[]	getHeaders()
short	getHTL()
PartiallyReceivedBlock	getPRB()
int	getPriority()
SSKBlock	getSSKBlock()
int	getStatus()
int	getTotalReceivedBytes()
int	getTotalSentBytes()
protected void	handleAcceptedRejectedTimeout(PeerNode next, UIDTag origTag)
protected boolean	isInsert()
boolean	isLocalRequestSearch()
boolean	isTransferCoalesced()
protected MessageFilter	makeAcceptedRejectedFilter(PeerNode next, long acceptedTimeout, UIDTag tag) Construct a filter to wait the specified time for accepted or rejected.
protected void	onAccepted(PeerNode next)
protected void	onAccepted(PeerNode next, boolean forked, short htl) If we handled a timeout, and forked, we need to know the original HTL.
void	receivedBytes(int x)
protected void	routeRequests() Route requests.
void	run()
void	sentBytes(int x) Sent some bytes.
void	sentPayload(int x) Sent payload - only include the number of bytes of actual payload i.e.
void	setTransferCoalesced()
void	start()
PeerNode	successFrom()
protected void	timedOutWhileWaiting(double load) We timed out while waiting for a slot from any node.
java.lang.String	toString()
PeerNode	transferringFrom()
boolean	transferStarted()
byte[]	waitForOpennetNoderef()
short	waitUntilStatusChange(short mask) Wait until either the transfer has started, we receive a RejectedOverload, or we get a terminal status code.

Methods inherited from class freenet.node.BaseSender

calculateTimeout, calculateTimeout, getLongSlotWaiterTimeout, getShortSlotWaiterTimeout, hopsForFatalTimeoutWaitingForPeer, ignoreLowBackoff, innerRouteRequests, innerRouteRequestsNew, innerRouteRequestsOld, isAccepted, routedLast, sourceForRouting, timeSinceSent

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestSender

public RequestSender(Key key,
                     DSAPublicKey pubKey,
                     short htl,
                     long uid,
                     RequestTag tag,
                     Node n,
                     PeerNode source,
                     boolean offersOnly,
                     boolean canWriteClientCache,
                     boolean canWriteDatastore,
                     boolean realTimeFlag)

RequestSender constructor.

Parameters:

key - The key to request. Its public key should have been looked up already; RequestSender will not look it up.

realTimeFlag - If enabled,

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

start

public void start()

run

public void run()

Specified by:

run in interface java.lang.Runnable

routeRequests

protected void routeRequests()

Route requests. Method is responsible for its own completion, e.g. finish or chaining to MainLoopCallback, i.e. the caller isn't going to do more stuff relevant to the request afterwards.

Specified by:

routeRequests in class BaseSender

makeAcceptedRejectedFilter

protected MessageFilter makeAcceptedRejectedFilter(PeerNode next,
                                                   long acceptedTimeout,
                                                   UIDTag tag)

Description copied from class: BaseSender

Construct a filter to wait the specified time for accepted or rejected. The actual messages may vary.

Specified by:

makeAcceptedRejectedFilter in class BaseSender

Parameters:

next - The peer we are waiting for a response from.

acceptedTimeout - The time to wait.

tag - Use the UID from this tag. Some requests may change the tag after some hops, and if e.g. waiting for confirmation after a timeout, we need to use the old tag.

createDataRequest

protected Message createDataRequest()

Specified by:

createDataRequest in class BaseSender

forwardRejectedOverload

protected void forwardRejectedOverload()

Forward RejectedOverload to the request originator

Specified by:

forwardRejectedOverload in class BaseSender

getPRB

public PartiallyReceivedBlock getPRB()

transferStarted

public boolean transferStarted()

waitUntilStatusChange

public short waitUntilStatusChange(short mask)

Wait until either the transfer has started, we receive a RejectedOverload, or we get a terminal status code. Must not return until we are finished - cannot timeout, because the caller will unlock the UID!

Parameters:

mask - Bitmask indicating what NOT to wait for i.e. the situation when this function exited last time (see WAIT_ constants above). Bits can also be set true even though they were not valid, to indicate that the caller doesn't care about that bit. If zero, function will throw an IllegalArgumentException.

Returns:

Bitmask indicating present situation. Can be fed back to this function, if nonzero.

waitForOpennetNoderef

public byte[] waitForOpennetNoderef()
                             throws freenet.node.OpennetManager.WaitedTooLongForOpennetNoderefException

Throws:

freenet.node.OpennetManager.WaitedTooLongForOpennetNoderefException

successFrom

public PeerNode successFrom()

getHeaders

public byte[] getHeaders()

getStatus

public int getStatus()

getHTL

public short getHTL()

getSSKBlock

public SSKBlock getSSKBlock()

sentBytes

public void sentBytes(int x)

Description copied from interface: ByteCounter

Sent some bytes. *Includes* any bytes flagged as already-reported-to-throttle.

Specified by:

sentBytes in interface ByteCounter

getTotalSentBytes

public int getTotalSentBytes()

receivedBytes

public void receivedBytes(int x)

Specified by:

receivedBytes in interface ByteCounter

getTotalReceivedBytes

public int getTotalReceivedBytes()

sentPayload

public void sentPayload(int x)

Description copied from interface: ByteCounter

Sent payload - only include the number of bytes of actual payload i.e. data from the user's point of view, as opposed to overhead. IMPORTANT: This will also be reported to sentBytes()! DO NOT ADD the total from sentBytes() to the total from sentPayloadBytes(), or you will double-count.

Specified by:

sentPayload in interface ByteCounter

Parameters:

x - Number of bytes sent

isLocalRequestSearch

public boolean isLocalRequestSearch()

addListener

public void addListener(RequestSenderListener l)

getPriority

public int getPriority()

Specified by:

getPriority in interface PrioRunnable

transferringFrom

public PeerNode transferringFrom()

abortedDownstreamTransfers

public boolean abortedDownstreamTransfers()

fetchTimeout

public long fetchTimeout()

setTransferCoalesced

public void setTransferCoalesced()

isTransferCoalesced

public boolean isTransferCoalesced()

onAccepted

protected void onAccepted(PeerNode next)

Specified by:

onAccepted in class BaseSender

onAccepted

protected void onAccepted(PeerNode next,
                          boolean forked,
                          short htl)

If we handled a timeout, and forked, we need to know the original HTL.

getAcceptedTimeout

protected long getAcceptedTimeout()

Specified by:

getAcceptedTimeout in class BaseSender

timedOutWhileWaiting

protected void timedOutWhileWaiting(double load)

Description copied from class: BaseSender

We timed out while waiting for a slot from any node. Fail the request.

Specified by:

timedOutWhileWaiting in class BaseSender

Parameters:

load - The proportion of requests getting timed out, on average, across the nodes we are waiting for. This is used to decide how long the RecentlyFailed should be for.

isInsert

protected boolean isInsert()

Specified by:

isInsert in class BaseSender

handleAcceptedRejectedTimeout

protected void handleAcceptedRejectedTimeout(PeerNode next,
                                             UIDTag origTag)

Specified by:

handleAcceptedRejectedTimeout in class BaseSender