org.cef.handler

Interface CefResourceHandler

All Known Implementing Classes:

CefResourceHandlerAdapter

public interface CefResourceHandler

Implement this interface to handle custom resource requests. This interface is a "new" API and an old API in one: the deprecated methods are part of the old API. The new API allows for parallel processing of requests, because it does not channel all reads through a dedicated IO thread, and it allows for skipping of bytes as part of handling Range requests.

Method Summary

Modifier and Type	Method and Description
void	cancel() Request processing has been canceled.
void	getResponseHeaders(CefResponse response, IntRef responseLength, StringRef redirectUrl) Retrieve response header information.
boolean	open(CefRequest request, BoolRef handleRequest, CefCallback callback) Open the response stream.
boolean	read(byte[] dataOut, int bytesToRead, IntRef bytesRead, CefResourceReadCallback callback) Read response data.
boolean	skip(long bytesToSkip, LongRef bytesSkipped, CefResourceSkipCallback callback) Skip response data when requested by a Range header.

Method Detail

cancel

void cancel()

Request processing has been canceled.

getResponseHeaders

void getResponseHeaders(CefResponse response,
                        IntRef responseLength,
                        StringRef redirectUrl)

Retrieve response header information. If the response length is not known set |responseLength| to -1 and readResponse() will be called until it returns false. If the response length is known set |responseLength| to a positive value and readResponse() will be called until it returns false or the specified number of bytes have been read. Use the |response| object to set the mime type, http status code and other optional header values.

Parameters:

response - The request response that should be returned. Instance only valid within the scope of this method.

responseLength - Optionally set the response length if known.

redirectUrl - Optionally redirect the request to a new URL.

open

boolean open(CefRequest request,
             BoolRef handleRequest,
             CefCallback callback)

Open the response stream. This and related (getResponseHeaders, read, skip) methods will be called in sequence but not from a dedicated thread.

For backwards compatibility set |handleRequest| to false and return false and the processRequest() method will be called.

Parameters:

request - The request itself. Cannot be modified in this callback. Instance only valid within the scope of this method.

handleRequest - Set to true to handle/cancel the request immediately

callback - Callback to continue or cancel the request at a later time

Returns:

True to handle the request

read

boolean read(byte[] dataOut,
             int bytesToRead,
             IntRef bytesRead,
             CefResourceReadCallback callback)

Read response data. If data is available immediately copy up to |bytesToRead| bytes into |dataOut|, set |bytesRead| to the number of bytes copied, and return true. To read the data at a later time store |dataOut|, set |bytesRead| to 0, return true and call the callback when the data is available. To indicate response completion set |bytesRead| to 0 and return false. To indicate failure set |bytesRead| to <0 (e.g. -2 for ERR_FAILED) and return false.

For backwards compatibility set |bytesRead| to -1 and return false and the readResponse() method will be called.

Parameters:

dataOut - Write data to this buffer. Buffer remains valid until either an immediate response is delivered (return true) or the callback is called later when data is available (return false).

bytesToRead - Size of the buffer.

bytesRead - Number of bytes written to the buffer.

callback - Callback to execute if data will be available asynchronously.

Returns:

True if more data is or will be available.

skip

boolean skip(long bytesToSkip,
             LongRef bytesSkipped,
             CefResourceSkipCallback callback)

Skip response data when requested by a Range header. Skip over and discard |bytesToSkip| bytes of response data. If data is available immediately set |bytesSkipped| to the number of bytes skipped and return true. To read the data at a later time set |bytesSkipped| to 0, return true and execute |callback| when the data is available. To indicate failure set |bytesSkipped| to < 0 (e.g. -2 for ERR_FAILED) and return false.

Parameters:

bytesToSkip - Number of bytes to skip.

bytesSkipped - Number of bytes skipped.

callback - Callback to execute if data will be skipped asynchronously.