freenet.node

Class MessageWrapper

java.lang.Object

freenet.node.MessageWrapper

public class MessageWrapper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MessageWrapper(MessageItem item, int messageID)

Method Summary

Modifier and Type	Method and Description
boolean	ack(int start, int end)
boolean	ack(int start, int end, BasePeerNode pn) Mark the given range as received.
boolean	allSent() Returns true if all the data of this MessageWrapper has been sent, and false otherwise.
int	getLength()
freenet.node.MessageFragment	getMessageFragment(int maxLength) Returns a MessageFragment with a length of maxLength or less, or null if there is nothing to send.
int	getMessageID()
int	getPriority()
boolean	isFirstFragment()
boolean	isFragmented(int length)
int	lost(int start, int end) Marks the given range of bytes as lost and returns the number of bytes that were lost.
void	onDisconnect()
void	onSent(int start, int end, int overhead, BasePeerNode pn) Called when data from this MessageWrapper is sent to another node.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageWrapper

public MessageWrapper(MessageItem item,
                      int messageID)

Method Detail

ack

public boolean ack(int start,
                   int end)

ack

public boolean ack(int start,
                   int end,
                   BasePeerNode pn)

Mark the given range as received.

Parameters:

start - the first byte to be marked

end - the last byte to be marked

pn - just for logging

Returns:

True if the whole packet has now been acked. False otherwise.

lost

public int lost(int start,
                int end)

Marks the given range of bytes as lost and returns the number of bytes that were lost. The input range is inclusive.

Parameters:

start - The first byte that is lost

end - The last byte that is lost

Returns:

The number of bytes lost

getMessageID

public int getMessageID()

getLength

public int getLength()

isFragmented

public boolean isFragmented(int length)

getPriority

public int getPriority()

isFirstFragment

public boolean isFirstFragment()

getMessageFragment

public freenet.node.MessageFragment getMessageFragment(int maxLength)

Returns a MessageFragment with a length of maxLength or less, or null if there is nothing to send. Ranges that have been returned by this function, and not marked as lost, and data that has been acked is never returned.

Parameters:

maxLength - The maximum length of the returned fragment

Returns:

a MessageFragment with a length of maxLength or less

onDisconnect

public void onDisconnect()

allSent

public boolean allSent()

Returns true if all the data of this MessageWrapper has been sent, and false otherwise.

Returns:

true if all the data of this MessageWrapper has been sent

onSent

public void onSent(int start,
                   int end,
                   int overhead,
                   BasePeerNode pn)

Called when data from this MessageWrapper is sent to another node.

Parameters:

start - The first byte that is sent

end - The last byte that is sent

overhead - The number of extra bytes used to send this message