freenet.client.async

Interface KeyListener

All Known Implementing Classes:

SingleKeyListener, SplitFileFetcherKeyListener, USKFetcher

public interface KeyListener

Transient object created on startup for persistent requests (or at creation time for non-persistent requests), to monitor the stream of successfully fetched keys. If a key appears interesting, we schedule a job on the database thread to double-check and process the data if we still want it.

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.

Method Detail

probablyWantKey

boolean probablyWantKey(Key key,
                        byte[] saltedKey)

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.

Returns:

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

definitelyWantKey

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. tripPendingKey() on the other hand will go straight to handleBlock().

Returns:

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

getRequestsForKey

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

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

handleBlock

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

Handle the found data, if we really want it.

persistent

boolean persistent()

Is this related to a persistent request?

getPriorityClass

short getPriorityClass()

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

countKeys

long countKeys()

getHasKeyListener

HasKeyListener getHasKeyListener()

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.

onRemove

void onRemove()

Deactivate the request once it has been removed.

isEmpty

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.

isSSK

boolean isSSK()