freenet.client.async

Class SingleKeyListener

java.lang.Object

freenet.client.async.SingleKeyListener

All Implemented Interfaces:

KeyListener

public class SingleKeyListener
extends java.lang.Object
implements KeyListener

Constructor Summary

Constructors

Constructor and Description
SingleKeyListener(Key key, BaseSingleFileFetcher fetcher, short prio, boolean persistent)

Method Summary

Modifier and Type	Method and Description
long	countKeys()
short	definitelyWantKey(Key key, byte[] saltedKey, ClientContext context) Do we want the key? This is called by the ULPR code, because fetching the key will involve significant work.
HasKeyListener	getHasKeyListener()
short	getPriorityClass() Priority of the associated request.
SendableGet[]	getRequestsForKey(Key key, byte[] saltedKey, ClientContext context) Find the requests related to a specific key, used in retrying after cooldown.
boolean	handleBlock(Key key, byte[] saltedKey, KeyBlock found, ClientContext context) Handle the found data, if we really want it.
boolean	isEmpty() Has the request finished? If every key has been found, or enough keys have been found, return true so that the caller can remove it from the list.
boolean	isSSK()
void	onRemove() Deactivate the request once it has been removed.
boolean	persistent() Is this related to a persistent request?
boolean	probablyWantKey(Key key, byte[] saltedKey) Fast guess at whether we want a key or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleKeyListener

public SingleKeyListener(Key key,
                         BaseSingleFileFetcher fetcher,
                         short prio,
                         boolean persistent)

Method Detail

countKeys

public long countKeys()

Specified by:

countKeys in interface KeyListener

definitelyWantKey

public short definitelyWantKey(Key key,
                               byte[] saltedKey,
                               ClientContext context)

Description copied from interface: KeyListener

Do we want the key? This is called by the ULPR code, because fetching the key will involve significant work. tripPendingKey() on the other hand will go straight to handleBlock().

Specified by:

definitelyWantKey in interface KeyListener

Returns:

-1 if we don't want the key, otherwise the priority of the request interested in the key.

getHasKeyListener

public HasKeyListener getHasKeyListener()

Specified by:

getHasKeyListener in interface KeyListener

Returns:

The parent HasKeyListener. This does mean it will be pinned in RAM, but it can be deactivated so it's not a big deal. LOCKING: Should avoid external locking if possible. Will be called within the CRSBase lock.

getPriorityClass

public short getPriorityClass()

Description copied from interface: KeyListener

Priority of the associated request. LOCKING: Should avoid external locking if possible. Will be called within the CRSBase lock.

Specified by:

getPriorityClass in interface KeyListener

getRequestsForKey

public SendableGet[] getRequestsForKey(Key key,
                                       byte[] saltedKey,
                                       ClientContext context)

Description copied from interface: KeyListener

Find the requests related to a specific key, used in retrying after cooldown. Caller should call probablyWantKey() first.

Specified by:

getRequestsForKey in interface KeyListener

handleBlock

public boolean handleBlock(Key key,
                           byte[] saltedKey,
                           KeyBlock found,
                           ClientContext context)

Description copied from interface: KeyListener

Handle the found data, if we really want it.

Specified by:

handleBlock in interface KeyListener

persistent

public boolean persistent()

Description copied from interface: KeyListener

Is this related to a persistent request?

Specified by:

persistent in interface KeyListener

probablyWantKey

public boolean probablyWantKey(Key key,
                               byte[] saltedKey)

Description copied from interface: KeyListener

Fast guess at whether we want a key or not. Usually implemented by a bloom filter. LOCKING: Should avoid external locking if possible. Will be called within the CRSBase lock.

Specified by:

probablyWantKey in interface KeyListener

Returns:

True if we probably want the key. False if we definitely don't want it.

onRemove

public void onRemove()

Description copied from interface: KeyListener

Deactivate the request once it has been removed.

Specified by:

onRemove in interface KeyListener

isEmpty

public boolean isEmpty()

Description copied from interface: KeyListener

Has the request finished? If every key has been found, or enough keys have been found, return true so that the caller can remove it from the list.

Specified by:

isEmpty in interface KeyListener

isSSK

public boolean isSSK()

Specified by:

isSSK in interface KeyListener