freenet.node

Class PeerMessageQueue

java.lang.Object

freenet.node.PeerMessageQueue

public class PeerMessageQueue
extends java.lang.Object

Queue of messages to send to a node. Ordered first by priority then by time. Will soon be round-robin between different transfers/UIDs/clients too.

Method Summary

Modifier and Type	Method and Description
long	getMessageQueueLengthBytes()
long	getNextUrgentTime(long t, long returnIfBefore) Get the time at which the next message must be sent.
MessageItem	grabQueuedMessageItem(int minPriority) Grab a message to send.
MessageItem[]	grabQueuedMessageItems()
boolean	mustSendNow(long now) Returns true if there are messages that will timeout before now.
boolean	mustSendSize(int minSize, int maxSize) Returns true if minSize + the length of all messages in this queue is greater than maxSize.
int	queueAndEstimateSize(MessageItem item, int maxSize) Queue a MessageItem and return an estimate of the size of this queue.
boolean	removeMessage(MessageItem message)
void	removeUIDsFromMessageQueues(java.lang.Long[] list)

Methods inherited from class java.lang.Object

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

Method Detail

queueAndEstimateSize

public int queueAndEstimateSize(MessageItem item,
                                int maxSize)

Queue a MessageItem and return an estimate of the size of this queue. The value returned is the estimated number of bytes needed for sending the all messages in this queue. Note that if the returned estimate is higher than 1024, it might not cover all messages.

Parameters:

item - the MessageItem to queue

Returns:

an estimate of the size of this queue

getMessageQueueLengthBytes

public long getMessageQueueLengthBytes()

grabQueuedMessageItems

public MessageItem[] grabQueuedMessageItems()

getNextUrgentTime

public long getNextUrgentTime(long t,
                              long returnIfBefore)

Get the time at which the next message must be sent. If any message is overdue, we will return a value less than now, which may not be completely accurate.

Parameters:

t - The current next urgent time. The return value will be no greater than this.

returnIfBefore - The current time. If the next urgent time is less than this we return immediately rather than computing an accurate past value. Set to Long.MAX_VALUE if you want an accurate value.

Returns:

The next urgent time, but can be too high if it is less than now.

mustSendNow

public boolean mustSendNow(long now)

Returns true if there are messages that will timeout before now.

Parameters:

now - the timeout for messages waiting to be sent

Returns:

true if there are messages that will timeout before now

mustSendSize

public boolean mustSendSize(int minSize,
                            int maxSize)

Returns true if minSize + the length of all messages in this queue is greater than maxSize.

Parameters:

minSize - the starting size

maxSize - the maximum size

Returns:

true if minSize + the length of all messages in this queue is greater than maxSize

grabQueuedMessageItem

public MessageItem grabQueuedMessageItem(int minPriority)

Grab a message to send. WARNING: PeerMessageQueue not only removes the message, it assumes it has been sent for purposes of fairness between UID's. You should try not to call this function if you are not going to be able to send the message: check in advance if possible.

removeMessage

public boolean removeMessage(MessageItem message)

removeUIDsFromMessageQueues

public void removeUIDsFromMessageQueues(java.lang.Long[] list)