freenet.node

Class CHKInsertSender

java.lang.Object

freenet.node.BaseSender

freenet.node.CHKInsertSender

All Implemented Interfaces:

ByteCounter, AnyInsertSender, PrioRunnable, java.lang.Runnable

public final class CHKInsertSender
extends BaseSender
implements PrioRunnable, AnyInsertSender, ByteCounter

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

Method Summary

Modifier and Type	Method and Description
boolean	anyTransfersFailed()
boolean	completed()
protected Message	createDataRequest()
boolean	failedReceive()
boolean	failIfReceiveFailed(InsertTag tag, PeerNode next)
protected void	forwardRejectedOverload() Forward RejectedOverload to the request originator.
protected long	getAcceptedTimeout()
byte[]	getHeaders()
short	getHTL()
int	getPriority()
byte[]	getPubkeyHash()
PeerNode[]	getRoutedTo()
int	getStatus()
java.lang.String	getStatusString()
int	getTotalReceivedBytes()
int	getTotalSentBytes()
long	getUID()
protected void	handleAcceptedRejectedTimeout(PeerNode next, UIDTag tag)
protected long	ignoreLowBackoff()
protected boolean	isInsert()
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)
void	onReceiveFailed() Called by CHKInsertHandler to notify that the receive has failed.
void	receivedBytes(int x)
protected void	routeRequests() The main route requests loop.
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.
boolean	sentRequest()
protected PeerNode	sourceForRouting()
boolean	startedSendingData()
protected void	timedOutWhileWaiting(double load) We timed out while waiting for a slot from any node.
java.lang.String	toString()
void	waitForStatus() Block until status has been set to something other than NOT_FINISHED

Methods inherited from class freenet.node.BaseSender

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

Methods inherited from class java.lang.Object

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

run

public void run()

Specified by:

run in interface java.lang.Runnable

routeRequests

protected void routeRequests()

Description copied from class: BaseSender

The main route requests loop. This must be filled in by the implementation. It will deal with decrementing the HTL, completing on running out of HTL, RecentlyFailed for requests, fork on cacheable for inserts, and so on. It will choose a peer and then chain to innerRouteRequests(), which in turn can call back to routeRequests() if it needs a new peer.

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.

handleAcceptedRejectedTimeout

protected void handleAcceptedRejectedTimeout(PeerNode next,
                                             UIDTag tag)

Specified by:

handleAcceptedRejectedTimeout in class BaseSender

forwardRejectedOverload

protected void forwardRejectedOverload()

Forward RejectedOverload to the request originator. DO NOT CALL if have a *local* RejectedOverload.

Specified by:

forwardRejectedOverload in class BaseSender

getStatus

public int getStatus()

Specified by:

getStatus in interface AnyInsertSender

getHTL

public short getHTL()

Specified by:

getHTL in interface AnyInsertSender

failIfReceiveFailed

public boolean failIfReceiveFailed(InsertTag tag,
                                   PeerNode next)

onReceiveFailed

public void onReceiveFailed()

Called by CHKInsertHandler to notify that the receive has failed.

getStatusString

public java.lang.String getStatusString()

Specified by:

getStatusString in interface AnyInsertSender

Returns:

The current status as a string

sentRequest

public boolean sentRequest()

Specified by:

sentRequest in interface AnyInsertSender

completed

public boolean completed()

waitForStatus

public void waitForStatus()

Block until status has been set to something other than NOT_FINISHED

anyTransfersFailed

public boolean anyTransfersFailed()

getPubkeyHash

public byte[] getPubkeyHash()

getHeaders

public byte[] getHeaders()

getUID

public long getUID()

Specified by:

getUID in interface AnyInsertSender

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

failedReceive

public boolean failedReceive()

startedSendingData

public boolean startedSendingData()

getPriority

public int getPriority()

Specified by:

getPriority in interface PrioRunnable

getRoutedTo

public PeerNode[] getRoutedTo()

createDataRequest

protected Message createDataRequest()

Specified by:

createDataRequest in class BaseSender

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.

onAccepted

protected void onAccepted(PeerNode next)

Specified by:

onAccepted in class BaseSender

isInsert

protected boolean isInsert()

Specified by:

isInsert in class BaseSender

sourceForRouting

protected PeerNode sourceForRouting()

Overrides:

sourceForRouting in class BaseSender

ignoreLowBackoff

protected long ignoreLowBackoff()

Overrides:

ignoreLowBackoff in class BaseSender