FProxyFetchInProgress (fred API)

java.lang.Object
- freenet.clients.http.FProxyFetchInProgress

All Implemented Interfaces:

ClientBaseCallback, ClientGetCallback, ClientEventListener
```
public class FProxyFetchInProgress
extends java.lang.Object
implements ClientEventListener, ClientGetCallback
```
Fetching a page for a browser. LOCKING: The lock on this object is always taken last.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FProxyFetchInProgress.REFILTER_POLICY` What to do when we find data which matches the request but it has already been filtered, assuming we want a filtered copy.

Field Summary

Fields
Modifier and Type Field and Description

long maxSize
The maximum size specified by the client

FreenetURI uri
The key we are fetching

Fields
Modifier and Type	Field and Description
`long`	`maxSize` The maximum size specified by the client
`FreenetURI`	`uri` The key we are fetching

Constructor Summary

Constructors
Constructor and Description
`FProxyFetchInProgress(FProxyFetchTracker tracker, FreenetURI key, long maxSize2, long identifier, ClientContext context, FetchContext fctx, RequestClient rc, FProxyFetchInProgress.REFILTER_POLICY refilter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomWaiter(FProxyFetchWaiter waiter)`
`void`	`addListener(FProxyFetchListener listener)` Adds a listener that will be notified when a change occurs to this fetch
`boolean`	`canCancel()` Caller should take the lock on FProxyToadlet.fetchers, then call this function, if it returns true then finish the cancel outside the lock.
`void`	`close(FProxyFetchResult result)`
`void`	`close(FProxyFetchWaiter waiter)`
`boolean`	`fetchContextEquivalent(FetchContext context)`
`void`	`finishCancel()` Finish the cancel process, freeing the data if necessary.
`boolean`	`finished()`
`long`	`getETA()`
`RequestClient`	`getRequestClient()` Get the RequestClient context object used to indicate which requests are related to each other for scheduling purposes.
`FProxyFetchTracker`	`getTracker()`
`FProxyFetchWaiter`	`getWaiter()`
`boolean`	`hasData()`
`boolean`	`hasNotifiedFailure()`
`boolean`	`hasWaited()`
`long`	`lastTouched()`
`boolean`	`notFinishedOrFatallyFinished()`
`void`	`onFailure(FetchException e, ClientGetter state)` Called on failed/canceled fetch.
`void`	`onResume(ClientContext context)` Called for a persistent request when the node is restarted.
`void`	`onSuccess(FetchResult result, ClientGetter state)` Called on successful fetch.
`void`	`receive(ClientEvent ce, ClientContext context)` Hears an event.
`void`	`removeListener(FProxyFetchListener listener)` Removes a listener
`void`	`requestImmediateCancel()` Allows the fetch to be removed immediately
`void`	`setHasWaited()`
`void`	`start(ClientContext context)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - uri
```
public final FreenetURI uri
```
    The key we are fetching
  - maxSize
```
public final long maxSize
```
    The maximum size specified by the client
- Constructor Detail
  - FProxyFetchInProgress
```
public FProxyFetchInProgress(FProxyFetchTracker tracker,
                             FreenetURI key,
                             long maxSize2,
                             long identifier,
                             ClientContext context,
                             FetchContext fctx,
                             RequestClient rc,
                             FProxyFetchInProgress.REFILTER_POLICY refilter)
```
- Method Detail
  - getWaiter
```
public FProxyFetchWaiter getWaiter()
```
  - getTracker
```
public FProxyFetchTracker getTracker()
```
  - addCustomWaiter
```
public void addCustomWaiter(FProxyFetchWaiter waiter)
```
  - start
```
public void start(ClientContext context)
           throws FetchException
```
    Throws:
    
    FetchException
  - receive
```
public void receive(ClientEvent ce,
                    ClientContext context)
```
    Description copied from interface: ClientEventListener
    
    Hears an event.
    
    Specified by:
    
    receive in interface ClientEventListener
    
    Parameters:
    
    ce - ClientEvent
    
    context - The database context the event was generated in. NOTE THAT IT MAY NOT HAVE BEEN GENERATED IN A DATABASE CONTEXT AT ALL: In this case, container will be null, and you should use context to schedule a DBJob.
  - onFailure
```
public void onFailure(FetchException e,
                      ClientGetter state)
```
    Description copied from interface: ClientGetCallback
    
    Called on failed/canceled fetch. Caller should schedule a job on the Ticker or Executor (on the ClientContext) if it needs to do much work.
    
    Specified by:
    
    onFailure in interface ClientGetCallback
  - onSuccess
```
public void onSuccess(FetchResult result,
                      ClientGetter state)
```
    Description copied from interface: ClientGetCallback
    
    Called on successful fetch. Caller should schedule a job on the Ticker or Executor (on the ClientContext) if it needs to do much work.
    
    Specified by:
    
    onSuccess in interface ClientGetCallback
  - hasData
```
public boolean hasData()
```
  - finished
```
public boolean finished()
```
  - close
```
public void close(FProxyFetchWaiter waiter)
```
  - canCancel
```
public boolean canCancel()
```
    Caller should take the lock on FProxyToadlet.fetchers, then call this function, if it returns true then finish the cancel outside the lock.
  - finishCancel
```
public void finishCancel()
```
    Finish the cancel process, freeing the data if necessary. The fetch must have been removed from the tracker already, so it won't be reused.
  - close
```
public void close(FProxyFetchResult result)
```
  - getETA
```
public long getETA()
```
  - notFinishedOrFatallyFinished
```
public boolean notFinishedOrFatallyFinished()
```
  - hasNotifiedFailure
```
public boolean hasNotifiedFailure()
```
  - hasWaited
```
public boolean hasWaited()
```
  - setHasWaited
```
public void setHasWaited()
```
  - addListener
```
public void addListener(FProxyFetchListener listener)
```
    Adds a listener that will be notified when a change occurs to this fetch
    
    Parameters:
    
    listener - - The listener to be added
  - removeListener
```
public void removeListener(FProxyFetchListener listener)
```
    Removes a listener
    
    Parameters:
    
    listener - - The listener to be removed
  - requestImmediateCancel
```
public void requestImmediateCancel()
```
    Allows the fetch to be removed immediately
  - lastTouched
```
public long lastTouched()
```
  - fetchContextEquivalent
```
public boolean fetchContextEquivalent(FetchContext context)
```
  - onResume
```
public void onResume(ClientContext context)
```
    Description copied from interface: ClientBaseCallback
    
    Called for a persistent request when the node is restarted. Must re-register with whatever infrastructure the request is using, e.g. PersistentRequestRoot, persistent temp buckets etc.
    
    Specified by:
    
    onResume in interface ClientBaseCallback
  - getRequestClient
```
public RequestClient getRequestClient()
```
    Description copied from interface: ClientBaseCallback
    
    Get the RequestClient context object used to indicate which requests are related to each other for scheduling purposes.
    
    Specified by:
    
    getRequestClient in interface ClientBaseCallback

Class FProxyFetchInProgress

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uri

maxSize

Constructor Detail

FProxyFetchInProgress

Method Detail

getWaiter

getTracker

addCustomWaiter

start

receive

onFailure

onSuccess

hasData

finished

close

canCancel

finishCancel

close

getETA

notFinishedOrFatallyFinished

hasNotifiedFailure

hasWaited

setHasWaited

addListener

removeListener

requestImmediateCancel

lastTouched

fetchContextEquivalent

onResume

getRequestClient