freenet.clients.fcp

Class PersistentRequestClient

java.lang.Object

freenet.clients.fcp.PersistentRequestClient

public class PersistentRequestClient
extends java.lang.Object

An FCP client. Identified by its Name which is sent on connection. Tracks persistent requests for either PERSISTENCE_REBOOT or PERSISTENCE_FOREVER.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isGlobalQueue Are we the global queue?

Constructor Summary

Constructors

Constructor and Description
PersistentRequestClient(java.lang.String name2, FCPConnectionHandler handler, boolean isGlobalQueue, RequestCompletionCallback cb, ClientRequest.Persistence persistence, PersistentRequestRoot root)

Method Summary

Modifier and Type	Method and Description
void	addPersistentRequesters(java.util.List<ClientRequester> requesters)
void	addPersistentRequests(java.util.List<ClientRequest> v, boolean onlyForever)
void	addPersistentRequestStatus(java.util.List<RequestStatus> status) From cache
void	addRequestCompletionCallback(RequestCompletionCallback cb)
void	finishedClientRequest(ClientRequest get) Called when a client request has finished, but is persistent.
ClientGet	getCompletedRequest(FreenetURI key)
FCPConnectionHandler	getConnection()
ClientRequest	getRequest(java.lang.String identifier)
RequestStatusCache	getRequestStatusCache()
boolean	hasPersistentRequests()
RequestClient	lowLevelClient(boolean realTime)
void	notifyFailure(ClientRequest req) Callback called when a request fails
void	notifySuccess(ClientRequest req) Callback called when a request succeeds.
void	onLostConnection(FCPConnectionHandler handler)
void	queueClientRequestMessage(FCPMessage msg, int verbosityLevel)
void	queueClientRequestMessage(FCPMessage msg, int verbosityLevel, boolean useGlobalMask)
int	queuePendingMessagesFromRunningRequests(FCPConnectionOutputHandler outputHandler, java.lang.String listRequestIdentifier, int offset, int max) Queue any and all pending messages from running requests.
int	queuePendingMessagesOnConnectionRestart(FCPConnectionOutputHandler outputHandler, java.lang.String listRequestIdentifier, int offset, int max) Queue any and all pending messages from already completed, unacknowledged, persistent requests, to be immediately sent.
void	queuePendingMessagesOnConnectionRestartAsync(FCPConnectionOutputHandler outputHandler, ClientContext context)
void	register(ClientRequest cg)
void	removeAll(ClientContext context)
boolean	removeByIdentifier(java.lang.String identifier, boolean kill, FCPServer server, ClientContext context)
void	removeRequestCompletionCallback(RequestCompletionCallback cb)
void	resume(ClientRequest clientRequest)
void	setConnection(FCPConnectionHandler handler)
boolean	setWatchGlobal(boolean enabled, int verbosityMask, FCPServer server) Enable or disable watch-the-global-queue.
java.lang.String	toString()
void	updateRequestStatusCache()

Methods inherited from class java.lang.Object

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

Field Detail

isGlobalQueue

public final boolean isGlobalQueue

Are we the global queue?

Constructor Detail

PersistentRequestClient

public PersistentRequestClient(java.lang.String name2,
                               FCPConnectionHandler handler,
                               boolean isGlobalQueue,
                               RequestCompletionCallback cb,
                               ClientRequest.Persistence persistence,
                               PersistentRequestRoot root)

Method Detail

getConnection

public FCPConnectionHandler getConnection()

setConnection

public void setConnection(FCPConnectionHandler handler)

onLostConnection

public void onLostConnection(FCPConnectionHandler handler)

finishedClientRequest

public void finishedClientRequest(ClientRequest get)

Called when a client request has finished, but is persistent. It has not been acked yet, so it should be moved to the unacked-completed-requests set.

queuePendingMessagesOnConnectionRestartAsync

public void queuePendingMessagesOnConnectionRestartAsync(FCPConnectionOutputHandler outputHandler,
                                                         ClientContext context)

queuePendingMessagesOnConnectionRestart

public int queuePendingMessagesOnConnectionRestart(FCPConnectionOutputHandler outputHandler,
                                                   java.lang.String listRequestIdentifier,
                                                   int offset,
                                                   int max)

Queue any and all pending messages from already completed, unacknowledged, persistent requests, to be immediately sent. This happens automatically on startup and hopefully will encourage clients to acknowledge persistent requests!

queuePendingMessagesFromRunningRequests

public int queuePendingMessagesFromRunningRequests(FCPConnectionOutputHandler outputHandler,
                                                   java.lang.String listRequestIdentifier,
                                                   int offset,
                                                   int max)

Queue any and all pending messages from running requests. Happens on demand.

register

public void register(ClientRequest cg)
              throws IdentifierCollisionException

Throws:

IdentifierCollisionException

removeByIdentifier

public boolean removeByIdentifier(java.lang.String identifier,
                                  boolean kill,
                                  FCPServer server,
                                  ClientContext context)

hasPersistentRequests

public boolean hasPersistentRequests()

addPersistentRequests

public void addPersistentRequests(java.util.List<ClientRequest> v,
                                  boolean onlyForever)

addPersistentRequestStatus

public void addPersistentRequestStatus(java.util.List<RequestStatus> status)

From cache

setWatchGlobal

public boolean setWatchGlobal(boolean enabled,
                              int verbosityMask,
                              FCPServer server)

Enable or disable watch-the-global-queue.

Parameters:

enabled - Whether we want watch-global-queue to be enabled.

verbosityMask - If so, what verbosity mask to use (to filter messages generated by the global queue).

queueClientRequestMessage

public void queueClientRequestMessage(FCPMessage msg,
                                      int verbosityLevel)

queueClientRequestMessage

public void queueClientRequestMessage(FCPMessage msg,
                                      int verbosityLevel,
                                      boolean useGlobalMask)

getRequest

public ClientRequest getRequest(java.lang.String identifier)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

notifySuccess

public void notifySuccess(ClientRequest req)

Callback called when a request succeeds.

notifyFailure

public void notifyFailure(ClientRequest req)

Callback called when a request fails

Parameters:

get -

addRequestCompletionCallback

public void addRequestCompletionCallback(RequestCompletionCallback cb)

removeRequestCompletionCallback

public void removeRequestCompletionCallback(RequestCompletionCallback cb)

removeAll

public void removeAll(ClientContext context)

getCompletedRequest

public ClientGet getCompletedRequest(FreenetURI key)

getRequestStatusCache

public RequestStatusCache getRequestStatusCache()

updateRequestStatusCache

public void updateRequestStatusCache()

lowLevelClient

public RequestClient lowLevelClient(boolean realTime)

addPersistentRequesters

public void addPersistentRequesters(java.util.List<ClientRequester> requesters)

resume

public void resume(ClientRequest clientRequest)