freenet.io.comm

Class MessageFilter

java.lang.Object

freenet.io.comm.MessageFilter

public final class MessageFilter
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
boolean	anyConnectionsDropped() Returns true if a connection related to this filter has been dropped or restarted.
void	clearMatched()
void	clearOr()
static MessageFilter	create()
PeerContext	droppedConnection() Which connection dropped or was restarted?
long	getInitialTimeout()
Message	getMessage()
PeerContext	getSource() Returns the source that this filter (or chain) matches
long	getTimeout()
boolean	hasCallback()
freenet.io.comm.MessageFilter.MATCHED	match(Message m, boolean noTimeout, long now)
freenet.io.comm.MessageFilter.MATCHED	match(Message m, long now)
boolean	matched()
boolean	matchesDroppedConnection(PeerContext ctx)
boolean	matchesRestartedConnection(PeerContext ctx)
void	onDroppedConnection(PeerContext ctx, Executor executor) Notify because of a dropped connection.
void	onMatched(Executor executor) Notify waiters that we have been matched.
void	onRestartedConnection(PeerContext ctx, Executor executor) Notify because of a restarted connection.
void	onTimedOut(Executor executor) Notify waiters that we have timed out.
MessageFilter	or(MessageFilter or) Modifies the filter so that it returns true if either it or the filter in the argument returns true.
MessageFilter	setAsyncCallback(AsyncMessageFilterCallback cb, ByteCounter ctr)
MessageFilter	setField(java.lang.String fieldName, boolean value)
MessageFilter	setField(java.lang.String fieldName, byte value)
MessageFilter	setField(java.lang.String fieldName, int value)
MessageFilter	setField(java.lang.String fieldName, long value)
MessageFilter	setField(java.lang.String fieldName, java.lang.Object fieldValue)
MessageFilter	setField(java.lang.String fieldName, short value)
void	setMessage(Message message)
MessageFilter	setNoTimeout()
MessageFilter	setSource(PeerContext source)
MessageFilter	setTimeout(long timeout) This filter will expire after the specificed amount of time.
MessageFilter	setTimeoutRelativeToCreation(boolean b) Set whether the timeout is relative to the creation of the filter, or the start of waitFor().
MessageFilter	setType(MessageType type)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Method Detail

create

public static MessageFilter create()

setTimeoutRelativeToCreation

public MessageFilter setTimeoutRelativeToCreation(boolean b)

Set whether the timeout is relative to the creation of the filter, or the start of waitFor().

Parameters:

b - If true, the timeout is relative to the time at which setTimeout() was called, if false, it's relative to the start of waitFor().

setTimeout

public MessageFilter setTimeout(long timeout)

This filter will expire after the specificed amount of time. Note also that where two or more filters match the same message, the one with the nearer expiry time will get priority

Parameters:

timeout - The time before this filter expires in ms

Returns:

This message filter

setNoTimeout

public MessageFilter setNoTimeout()

setType

public MessageFilter setType(MessageType type)

setSource

public MessageFilter setSource(PeerContext source)

getSource

public PeerContext getSource()

Returns the source that this filter (or chain) matches

setField

public MessageFilter setField(java.lang.String fieldName,
                              boolean value)

setField

public MessageFilter setField(java.lang.String fieldName,
                              byte value)

setField

public MessageFilter setField(java.lang.String fieldName,
                              short value)

setField

public MessageFilter setField(java.lang.String fieldName,
                              int value)

setField

public MessageFilter setField(java.lang.String fieldName,
                              long value)

setField

public MessageFilter setField(java.lang.String fieldName,
                              java.lang.Object fieldValue)

or

public MessageFilter or(MessageFilter or)

Modifies the filter so that it returns true if either it or the filter in the argument returns true. Multiple combinations must be nested: such as filter1.or(filter2.or(filter3))).

Returns:

reference to this, the modified filter.

setAsyncCallback

public MessageFilter setAsyncCallback(AsyncMessageFilterCallback cb,
                                      ByteCounter ctr)

match

public freenet.io.comm.MessageFilter.MATCHED match(Message m,
                                                   long now)

match

public freenet.io.comm.MessageFilter.MATCHED match(Message m,
                                                   boolean noTimeout,
                                                   long now)

matched

public boolean matched()

droppedConnection

public PeerContext droppedConnection()

Which connection dropped or was restarted?

getMessage

public Message getMessage()

setMessage

public void setMessage(Message message)

getInitialTimeout

public long getInitialTimeout()

getTimeout

public long getTimeout()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clearMatched

public void clearMatched()

clearOr

public void clearOr()

matchesDroppedConnection

public boolean matchesDroppedConnection(PeerContext ctx)

matchesRestartedConnection

public boolean matchesRestartedConnection(PeerContext ctx)

onDroppedConnection

public void onDroppedConnection(PeerContext ctx,
                                Executor executor)

Notify because of a dropped connection. Caller must verify _matchesDroppedConnection and _source.

Parameters:

ctx -

onRestartedConnection

public void onRestartedConnection(PeerContext ctx,
                                  Executor executor)

Notify because of a restarted connection. Caller must verify _matchesDroppedConnection and _source.

Parameters:

ctx -

onMatched

public void onMatched(Executor executor)

Notify waiters that we have been matched. Hopefully no locks will be held at this point by the caller.

onTimedOut

public void onTimedOut(Executor executor)

Notify waiters that we have timed out.

anyConnectionsDropped

public boolean anyConnectionsDropped()

Returns true if a connection related to this filter has been dropped or restarted.

hasCallback

public boolean hasCallback()