freenet.node

Class MessageItem

java.lang.Object

freenet.node.MessageItem

public class MessageItem
extends java.lang.Object

A queued byte[], maybe including a Message, and a callback, which may be null. Note that we always create the byte[] on construction, as almost everywhere which uses a MessageItem needs to know its length immediately.

Constructor Summary

Constructors

Constructor and Description
MessageItem(byte[] data, AsyncMessageCallback[] cb2, boolean formatted, ByteCounter ctr, short priority, boolean sendLoadRT, boolean sendLoadBulk)
MessageItem(Message msg2, AsyncMessageCallback[] cb2, ByteCounter ctr)
MessageItem(Message msg2, AsyncMessageCallback[] cb2, ByteCounter ctr, short overridePriority)

Method Summary

Modifier and Type	Method and Description
void	clearDeadline() Clear the deadline for this message.
byte[]	getData() Return the data contents of this MessageItem.
long	getDeadline() Get the deadline for this message.
long	getID()
int	getLength()
short	getPriority()
void	onDisconnect()
void	onFailed()
void	onSent(int length)
void	onSentAll() Called the first time we have sent all of the message.
void	setDeadline(long time) Set the deadline for this message.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageItem

public MessageItem(Message msg2,
                   AsyncMessageCallback[] cb2,
                   ByteCounter ctr,
                   short overridePriority)

MessageItem

public MessageItem(Message msg2,
                   AsyncMessageCallback[] cb2,
                   ByteCounter ctr)

MessageItem

public MessageItem(byte[] data,
                   AsyncMessageCallback[] cb2,
                   boolean formatted,
                   ByteCounter ctr,
                   short priority,
                   boolean sendLoadRT,
                   boolean sendLoadBulk)

Method Detail

getData

public byte[] getData()

Return the data contents of this MessageItem.

getLength

public int getLength()

onSent

public void onSent(int length)

Parameters:

length - The actual number of bytes sent to send this message, including our share of the packet overheads, *and including alreadyReportedBytes*, which is only used when deciding how many bytes to report to the throttle.

getPriority

public short getPriority()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

onDisconnect

public void onDisconnect()

onFailed

public void onFailed()

getID

public long getID()

onSentAll

public void onSentAll()

Called the first time we have sent all of the message.

setDeadline

public void setDeadline(long time)

Set the deadline for this message. Called when a message is unqueued, when we start to send it. Used if the message does not entirely fit in the packet, and also if it is retransmitted.

Parameters:

time - The time (in the future) to set the deadline to.

clearDeadline

public void clearDeadline()

Clear the deadline for this message.

getDeadline

public long getDeadline()

Get the deadline for this message. 0 means no deadline has been set.