freenet.node

Class BaseSender

java.lang.Object

freenet.node.BaseSender

All Implemented Interfaces:

ByteCounter

Direct Known Subclasses:

CHKInsertSender, RequestSender, SSKInsertSender

public abstract class BaseSender
extends java.lang.Object
implements ByteCounter

Base class for request and insert senders. Mostly concerned with what happens *before and up to* we get the Accepted. After that it hands over to the child class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseSender.DO

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dontDecrementHTLThisTime If this is set, don't decrement HTL, and then unset it.
protected int	gotMessages
protected boolean	hasForwarded
protected short	htl
protected java.lang.String	lastMessage
protected PeerNode	lastNode
protected java.util.HashSet<PeerNode>	nodesRoutedTo
protected short	origHTL
protected int	rejectOverloads
protected int	routeAttempts
protected long	startTime

Method Summary

Modifier and Type	Method and Description
static int	calculateTimeout(boolean realTimeFlag, short htl, Node node)
protected int	calculateTimeout(short htl)
protected abstract Message	createDataRequest()
protected abstract void	forwardRejectedOverload()
protected abstract long	getAcceptedTimeout()
protected long	getLongSlotWaiterTimeout()
protected long	getShortSlotWaiterTimeout()
protected abstract void	handleAcceptedRejectedTimeout(PeerNode next, UIDTag origTag)
protected short	hopsForFatalTimeoutWaitingForPeer()
protected long	ignoreLowBackoff()
protected void	innerRouteRequests(PeerNode next, UIDTag origTag)
protected void	innerRouteRequestsNew(PeerNode next, UIDTag origTag) New load management.
protected void	innerRouteRequestsOld(PeerNode next, UIDTag origTag)
protected boolean	isAccepted(Message msg)
protected abstract boolean	isInsert()
protected abstract MessageFilter	makeAcceptedRejectedFilter(PeerNode next, long acceptedTimeout, UIDTag tag) Construct a filter to wait the specified time for accepted or rejected.
protected abstract void	onAccepted(PeerNode next)
PeerNode	routedLast()
protected abstract void	routeRequests() The main route requests loop.
protected PeerNode	sourceForRouting()
protected abstract void	timedOutWhileWaiting(double load) We timed out while waiting for a slot from any node.
protected int	timeSinceSent()

Methods inherited from class java.lang.Object

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

Methods inherited from interface freenet.io.comm.ByteCounter

receivedBytes, sentBytes, sentPayload

Field Detail

origHTL

protected final short origHTL

startTime

protected final long startTime

lastNode

protected PeerNode lastNode

nodesRoutedTo

protected java.util.HashSet<PeerNode> nodesRoutedTo

hasForwarded

protected boolean hasForwarded

gotMessages

protected int gotMessages

lastMessage

protected java.lang.String lastMessage

htl

protected short htl

rejectOverloads

protected int rejectOverloads

routeAttempts

protected int routeAttempts

dontDecrementHTLThisTime

protected boolean dontDecrementHTLThisTime

If this is set, don't decrement HTL, and then unset it.

Method Detail

calculateTimeout

public static int calculateTimeout(boolean realTimeFlag,
                                   short htl,
                                   Node node)

calculateTimeout

protected int calculateTimeout(short htl)

createDataRequest

protected abstract Message createDataRequest()

routedLast

public PeerNode routedLast()

timeSinceSent

protected int timeSinceSent()

routeRequests

protected abstract void routeRequests()

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.

innerRouteRequests

protected void innerRouteRequests(PeerNode next,
                                  UIDTag origTag)

innerRouteRequestsOld

protected void innerRouteRequestsOld(PeerNode next,
                                     UIDTag origTag)

innerRouteRequestsNew

protected void innerRouteRequestsNew(PeerNode next,
                                     UIDTag origTag)

New load management. Give it the peer you want to route to, it might route to a different one, but it will either get accepted and call onAccepted(), or decide it needs to reroute and call routeRequests(). IMPORTANT: Caller must not decrement htl when rerouting if dontDecrementHTLThisTime is set (but must still reroute); this happens when we discover too that the proposed peer is no longer suitable. One of the reasons for this is that BaseSender does not handle RecentlyFailedReturn, which can only happen in the main peer selection loop. If we set it, we haven't routed to a peer (we might have been soft-rejected, but that is not serious in NLM).

Parameters:

next - The peer that we have routed to. We won't necessarily route to this one in all cases.

sourceForRouting

protected PeerNode sourceForRouting()

getLongSlotWaiterTimeout

protected long getLongSlotWaiterTimeout()

getShortSlotWaiterTimeout

protected long getShortSlotWaiterTimeout()

hopsForFatalTimeoutWaitingForPeer

protected short hopsForFatalTimeoutWaitingForPeer()

handleAcceptedRejectedTimeout

protected abstract void handleAcceptedRejectedTimeout(PeerNode next,
                                                      UIDTag origTag)

isAccepted

protected boolean isAccepted(Message msg)

getAcceptedTimeout

protected abstract long getAcceptedTimeout()

timedOutWhileWaiting

protected abstract void timedOutWhileWaiting(double load)

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

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 abstract void onAccepted(PeerNode next)

makeAcceptedRejectedFilter

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

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

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.

forwardRejectedOverload

protected abstract void forwardRejectedOverload()

isInsert

protected abstract boolean isInsert()

ignoreLowBackoff

protected long ignoreLowBackoff()