Click or drag to resize
CfxResponseFilter Class

[This is preliminary documentation and is subject to change.]

Implement this structure to filter resource response content. The functions of this structure will be called on the browser process IO thread.
Inheritance Hierarchy
SystemObject
  ChromiumCfxObject
    ChromiumCfxBase
      ChromiumCfxClientBase
        ChromiumCfxResponseFilter

Namespace: Chromium
Assembly: ChromiumFX (in ChromiumFX.dll)
Syntax
public class CfxResponseFilter : CfxClientBase

The CfxResponseFilter type exposes the following members.

Constructors
  NameDescription
Public methodCfxResponseFilter
Initializes a new instance of the CfxResponseFilter class
Top
Properties
  NameDescription
Public propertyCallbacksDisabled
When true, all CEF callback events are disabled for this handler. Incoming callbacks will return default values to CEF.
(Inherited from CfxClientBase.)
Public propertyNativePtr
Provides access to the underlying native cef struct. This is a refcounted client struct derived from cef_base_t. Add a ref in order to keep it alive when this managed object go out of scope.
(Inherited from CfxClientBase.)
Top
Events
  NameDescription
Public eventFilter
Called to filter a chunk of data. Expected usage is as follows: A. Read input data from |DataIn| and set |DataInRead| to the number of bytes that were read up to a maximum of |DataInSize|. |DataIn| will be NULL if |DataInSize| is zero. B. Write filtered output data to |DataOut| and set |DataOutWritten| to the number of bytes that were written up to a maximum of |DataOutSize|. If no output data was written then all data must be read from |DataIn| (user must set |DataInRead| = |DataInSize|). C. Return RESPONSE_FILTER_DONE if all output data was written or RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending. This function will be called repeatedly until the input buffer has been fully read (user sets |DataInRead| = |DataInSize|) and there is no more input data to filter (the resource response is complete). This function may then be called an additional time with an NULL input buffer if the user filled the output buffer (set |DataOutWritten| = |DataOutSize|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending. Calls to this function will stop when one of the following conditions is met: A. There is no more input data to filter (the resource response is complete) and the user sets |DataOutWritten| = 0 or returns RESPONSE_FILTER_DONE to indicate that all data has been written, or; B. The user returns RESPONSE_FILTER_ERROR to indicate an error. Do not keep a reference to the buffers passed to this function.
Public eventInitFilter
Initialize the response filter. Will only be called a single time. The filter will not be installed if this function returns false (0).
Top
Remarks
See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.
See Also