Delphi/CEF4Delphi
1
0
Fork 0
mirror of https://github.com/salvadordf/CEF4Delphi.git synced 2024-11-15 07:45:56 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added more code comments.

Browse Source 
Added documentation for ICefResponseFilter, TCustomResponseFilter, TCefResponseFilterRef and TCefResponseFilterOwn
This commit is contained in:
Salvador Díaz Fau 2024-04-20 17:46:13 +02:00
parent 7d822c5340
commit 82f6d8eeb6
12 changed files with 406 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/cef4delphi.chm
View File

Binary file not shown.

6
docs/html/AllClasses.html
View File

@ -2484,12 +2484,12 @@
<tr class="list">
<td class="itemname"><a class="bold" href="uCEFResponseFilter.TCefResponseFilterOwn.html">TCefResponseFilterOwn</a></td>
<td class="itemunit"><a class="bold" href="uCEFResponseFilter.html">uCEFResponseFilter</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
<td class="itemdesc"><p> Owned class implementing a resource filter. </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="uCEFResponseFilter.TCefResponseFilterRef.html">TCefResponseFilterRef</a></td>
<td class="itemunit"><a class="bold" href="uCEFResponseFilter.html">uCEFResponseFilter</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
<td class="itemdesc"><p> Reference class implementing a resource filter. </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="uCEFResponse.TCefResponseRef.html">TCefResponseRef</a></td>
@ -3408,7 +3408,7 @@
<tr class="list">
<td class="itemname"><a class="bold" href="uCEFResponseFilter.TCustomResponseFilter.html">TCustomResponseFilter</a></td>
<td class="itemunit"><a class="bold" href="uCEFResponseFilter.html">uCEFResponseFilter</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
<td class="itemdesc"><p> Custom class implementing a resource filter with events. </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="uCEFServerHandler.TCustomServerHandler.html">TCustomServerHandler</a></td>

6
docs/html/AllIdentifiers.html
View File

@ -11093,12 +11093,12 @@ Ranges:
<tr class="list2">
<td class="itemname"><a class="bold" href="uCEFResponseFilter.TCefResponseFilterOwn.html">TCefResponseFilterOwn</a></td>
<td class="itemunit"><a class="bold" href="uCEFResponseFilter.html">uCEFResponseFilter</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
<td class="itemdesc"><p> Owned class implementing a resource filter. </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="uCEFResponseFilter.TCefResponseFilterRef.html">TCefResponseFilterRef</a></td>
<td class="itemunit"><a class="bold" href="uCEFResponseFilter.html">uCEFResponseFilter</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
<td class="itemdesc"><p> Reference class implementing a resource filter. </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="uCEFTypes.html#TCefResponseFilterStatus">TCefResponseFilterStatus</a></td>
@ -12282,7 +12282,7 @@ Ranges:
<tr class="list">
<td class="itemname"><a class="bold" href="uCEFResponseFilter.TCustomResponseFilter.html">TCustomResponseFilter</a></td>
<td class="itemunit"><a class="bold" href="uCEFResponseFilter.html">uCEFResponseFilter</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
<td class="itemdesc"><p> Custom class implementing a resource filter with events. </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="uCEFServerHandler.TCustomServerHandler.html">TCustomServerHandler</a></td>

8
docs/html/cef4delphi.log
View File

@ -925,12 +925,12 @@ published.gif
automated.gif
pasdoc.css
Compile time: 0 minutes, 14 seconds
Compile time: 0 minutes, 15 seconds
16,138 Topics
137,728 Local links
137,730 Local links
35 Internet links
5 Graphics
Created c:\Users\usuario\Documents\Embarcadero\Studio\Projects\CEF4Delphi\docs\cef4delphi.chm, 3,516,164 bytes
Compression decreased file by 22,971,062 bytes.
Created c:\Users\usuario\Documents\Embarcadero\Studio\Projects\CEF4Delphi\docs\cef4delphi.chm, 3,522,122 bytes
Compression decreased file by 22,975,919 bytes.

43
docs/html/uCEFInterfaces.ICefResponseFilter.html
View File

@ -49,7 +49,9 @@
<td class="itemcode"><span id="InitFilter"></span><code>function <strong>InitFilter</strong>: Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p><h6 class="description_section">Attributes</h6>
<p>
Initialize the response filter. Will only be called a single time. The filter will not be installed if this function returns false (0). </p>
<h6 class="description_section">Attributes</h6>
<dl class="attributes">
<dt>GUID['{5013BC3C-F1AE-407A-A571-A4C6B1D6831E}']</dt>
<dd></dd>
@ -62,7 +64,44 @@
<td class="itemcode"><span id="Filter-Pointer-NativeUInt-NativeUInt-Pointer-NativeUInt-NativeUInt-"></span><code>function <strong>Filter</strong>(data_in: Pointer; data_in_size: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; var data_in_read: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; data_out: Pointer; data_out_size : <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; var data_out_written: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): <a href="uCEFTypes.html#TCefResponseFilterStatus">TCefResponseFilterStatus</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p>
<p>Called to filter a chunk of data. Expected usage is as follows:
<p></p>
<pre class="preformatted">
1. Read input data from |data_in| and set |data_in_read| to the number of
bytes that were read up to a maximum of |data_in_size|. |data_in| will
be NULL if |data_in_size| is zero.
2. Write filtered output data to |data_out| and set |data_out_written| to
the number of bytes that were written up to a maximum of
|data_out_size|. If no output data was written then all data must be
read from |data_in| (user must set |data_in_read| = |data_in_size|).
3. Return RESPONSE_FILTER_DONE if all output data was written or
RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.</pre>
<p>
<p>This function will be called repeatedly until the input buffer has been fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| = |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending.
<p>Calls to this function will stop when one of the following conditions is met:
<p></p>
<pre class="preformatted">
1. There is no more input data to filter (the resource response is
complete) and the user sets |data_out_written| = 0 or returns
RESPONSE_FILTER_DONE to indicate that all data has been written, or;
2. The user returns RESPONSE_FILTER_ERROR to indicate an error.</pre>
<p>
<p>Do not keep a reference to the buffers passed to this function.
<p></p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0-snapshot</a>. </em>
</span>

53
docs/html/uCEFResponseFilter.TCefResponseFilterOwn.html
View File

@ -18,7 +18,15 @@
<p class="declaration">
<code>type TCefResponseFilterOwn = class(<a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedOwn.html">TCefBaseRefCountedOwn</a>, <a class="normal" href="uCEFInterfaces.ICefResponseFilter.html">ICefResponseFilter</a>)</code></p>
<h2 class="description">Description</h2>
<p class="nodescription">This item has no description.</p><span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<p>
Owned class implementing a resource filter. </p>
<p>
<p>The functions of this interface will be called on the browser process IO thread.
<p>&lt;see href=&quot;<a href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h">https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h</a>&quot;&gt;CEF source file: /include/capi/cef_response_filter_capi.h (cef_response_filter_t))</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TInterfacedObject</li>
<li class="ancestor"><a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedOwn.html">TCefBaseRefCountedOwn</a></li>
<li class="thisitem">TCefResponseFilterOwn</li></ul><h2 class="overview">Overview</h2>
@ -45,7 +53,9 @@
<td class="itemcode"><span id="InitFilter"></span><code>function <strong>InitFilter</strong>: Boolean; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p>
Initialize the response filter. Will only be called a single time. The filter will not be installed if this function returns false (0). </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
@ -53,7 +63,44 @@
<td class="itemcode"><span id="Filter-Pointer-NativeUInt-NativeUInt-Pointer-NativeUInt-NativeUInt-"></span><code>function <strong>Filter</strong>(data_in: Pointer; data_in_size: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; var data_in_read: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; data_out: Pointer; data_out_size : <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; var data_out_written: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): <a href="uCEFTypes.html#TCefResponseFilterStatus">TCefResponseFilterStatus</a>; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p>
<p>Called to filter a chunk of data. Expected usage is as follows:
<p></p>
<pre class="preformatted">
1. Read input data from |data_in| and set |data_in_read| to the number of
bytes that were read up to a maximum of |data_in_size|. |data_in| will
be NULL if |data_in_size| is zero.
2. Write filtered output data to |data_out| and set |data_out_written| to
the number of bytes that were written up to a maximum of
|data_out_size|. If no output data was written then all data must be
read from |data_in| (user must set |data_in_read| = |data_in_size|).
3. Return RESPONSE_FILTER_DONE if all output data was written or
RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.</pre>
<p>
<p>This function will be called repeatedly until the input buffer has been fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| = |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending.
<p>Calls to this function will stop when one of the following conditions is met:
<p></p>
<pre class="preformatted">
1. There is no more input data to filter (the resource response is
complete) and the user sets |data_out_written| = 0 or returns
RESPONSE_FILTER_DONE to indicate that all data has been written, or;
2. The user returns RESPONSE_FILTER_ERROR to indicate an error.</pre>
<p>
<p>Do not keep a reference to the buffers passed to this function.
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">

53
docs/html/uCEFResponseFilter.TCefResponseFilterRef.html
View File

@ -18,7 +18,15 @@
<p class="declaration">
<code>type TCefResponseFilterRef = class(<a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedRef.html">TCefBaseRefCountedRef</a>, <a class="normal" href="uCEFInterfaces.ICefResponseFilter.html">ICefResponseFilter</a>)</code></p>
<h2 class="description">Description</h2>
<p class="nodescription">This item has no description.</p><span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<p>
Reference class implementing a resource filter. </p>
<p>
<p>The functions of this interface will be called on the browser process IO thread.
<p>&lt;see href=&quot;<a href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h">https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h</a>&quot;&gt;CEF source file: /include/capi/cef_response_filter_capi.h (cef_response_filter_t))</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TInterfacedObject</li>
<li class="ancestor"><a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedRef.html">TCefBaseRefCountedRef</a></li>
<li class="thisitem">TCefResponseFilterRef</li></ul><h2 class="overview">Overview</h2>
@ -45,7 +53,9 @@
<td class="itemcode"><span id="InitFilter"></span><code>function <strong>InitFilter</strong>: Boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p>
Initialize the response filter. Will only be called a single time. The filter will not be installed if this function returns false (0). </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
@ -53,7 +63,44 @@
<td class="itemcode"><span id="Filter-Pointer-NativeUInt-NativeUInt-Pointer-NativeUInt-NativeUInt-"></span><code>function <strong>Filter</strong>(data_in: Pointer; data_in_size: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; var data_in_read: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; data_out: Pointer; data_out_size : <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; var data_out_written: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): <a href="uCEFTypes.html#TCefResponseFilterStatus">TCefResponseFilterStatus</a>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p>
<p>Called to filter a chunk of data. Expected usage is as follows:
<p></p>
<pre class="preformatted">
1. Read input data from |data_in| and set |data_in_read| to the number of
bytes that were read up to a maximum of |data_in_size|. |data_in| will
be NULL if |data_in_size| is zero.
2. Write filtered output data to |data_out| and set |data_out_written| to
the number of bytes that were written up to a maximum of
|data_out_size|. If no output data was written then all data must be
read from |data_in| (user must set |data_in_read| = |data_in_size|).
3. Return RESPONSE_FILTER_DONE if all output data was written or
RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.</pre>
<p>
<p>This function will be called repeatedly until the input buffer has been fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| = |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending.
<p>Calls to this function will stop when one of the following conditions is met:
<p></p>
<pre class="preformatted">
1. There is no more input data to filter (the resource response is
complete) and the user sets |data_out_written| = 0 or returns
RESPONSE_FILTER_DONE to indicate that all data has been written, or;
2. The user returns RESPONSE_FILTER_ERROR to indicate an error.</pre>
<p>
<p>Do not keep a reference to the buffers passed to this function.
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">

98
docs/html/uCEFResponseFilter.TCustomResponseFilter.html
View File

@ -18,7 +18,15 @@
<p class="declaration">
<code>type TCustomResponseFilter = class(<a class="normal" href="uCEFResponseFilter.TCefResponseFilterOwn.html">TCefResponseFilterOwn</a>)</code></p>
<h2 class="description">Description</h2>
<p class="nodescription">This item has no description.</p><span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<p>
Custom class implementing a resource filter with events. </p>
<p>
<p>The functions and events of this interface will be called on the browser process IO thread.
<p>&lt;see href=&quot;<a href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h">https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h</a>&quot;&gt;CEF source file: /include/capi/cef_response_filter_capi.h (cef_response_filter_t))</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TInterfacedObject</li>
<li class="ancestor"><a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedOwn.html">TCefBaseRefCountedOwn</a></li>
<li class="ancestor"><a class="normal" href="uCEFResponseFilter.TCefResponseFilterOwn.html">TCefResponseFilterOwn</a></li>
@ -85,7 +93,9 @@
<td class="itemcode"><span id="InitFilter"></span><code>function <strong>InitFilter</strong>: Boolean; override;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFResponseFilter.TCefResponseFilterOwn.html#InitFilter">TCefResponseFilterOwn.InitFilter</a>.</p><p>
Initialize the response filter. Will only be called a single time. The filter will not be installed if this function returns false (0). </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
@ -93,7 +103,44 @@
<td class="itemcode"><span id="Filter-Pointer-NativeUInt-NativeUInt-Pointer-NativeUInt-NativeUInt-"></span><code>function <strong>Filter</strong>(data_in: Pointer; data_in_size: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; var data_in_read: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; data_out: Pointer; data_out_size : <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>; var data_out_written: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>): <a href="uCEFTypes.html#TCefResponseFilterStatus">TCefResponseFilterStatus</a>; override;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p class="inheritdescription">This item has no description. Showing description inherited from <a class="normal" href="uCEFResponseFilter.TCefResponseFilterOwn.html#Filter-Pointer-NativeUInt-NativeUInt-Pointer-NativeUInt-NativeUInt-">TCefResponseFilterOwn.Filter</a>.</p><p>
<p>Called to filter a chunk of data. Expected usage is as follows:
<p></p>
<pre class="preformatted">
1. Read input data from |data_in| and set |data_in_read| to the number of
bytes that were read up to a maximum of |data_in_size|. |data_in| will
be NULL if |data_in_size| is zero.
2. Write filtered output data to |data_out| and set |data_out_written| to
the number of bytes that were written up to a maximum of
|data_out_size|. If no output data was written then all data must be
read from |data_in| (user must set |data_in_read| = |data_in_size|).
3. Return RESPONSE_FILTER_DONE if all output data was written or
RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.</pre>
<p>
<p>This function will be called repeatedly until the input buffer has been fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| = |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending.
<p>Calls to this function will stop when one of the following conditions is met:
<p></p>
<pre class="preformatted">
1. There is no more input data to filter (the resource response is
complete) and the user sets |data_out_written| = 0 or returns
RESPONSE_FILTER_DONE to indicate that all data has been written, or;
2. The user returns RESPONSE_FILTER_ERROR to indicate an error.</pre>
<p>
<p>Do not keep a reference to the buffers passed to this function.
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
@ -110,7 +157,46 @@
<td class="itemcode"><span id="OnFilter"></span><code>property <strong>OnFilter</strong> : <a href="uCEFResponseFilter.html#TOnFilterEvent">TOnFilterEvent</a> read <a href="uCEFResponseFilter.TCustomResponseFilter.html#FOnFilter">FOnFilter</a> write <a href="uCEFResponseFilter.TCustomResponseFilter.html#FOnFilter">FOnFilter</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p>
<p>OnFilter is triggered when ICefResponseFilter.Filter is executed to filter a chunk of data.
<p>Expected usage is as follows:
<p></p>
<pre class="preformatted">
1. Read input data from |data_in| and set |data_in_read| to the number of
bytes that were read up to a maximum of |data_in_size|. |data_in| will
be NULL if |data_in_size| is zero.
2. Write filtered output data to |data_out| and set |data_out_written| to
the number of bytes that were written up to a maximum of
|data_out_size|. If no output data was written then all data must be
read from |data_in| (user must set |data_in_read| = |data_in_size|).
3. Return RESPONSE_FILTER_DONE if all output data was written or
RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.</pre>
<p>
<p>This function will be called repeatedly until the input buffer has been fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| = |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending.
<p>Calls to this function will stop when one of the following conditions is met:
<p></p>
<pre class="preformatted">
1. There is no more input data to filter (the resource response is
complete) and the user sets |data_out_written| = 0 or returns
RESPONSE_FILTER_DONE to indicate that all data has been written, or;
2. The user returns RESPONSE_FILTER_ERROR to indicate an error.</pre>
<p>
<p>Do not keep a reference to the buffers passed to this function.
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
@ -118,7 +204,9 @@
<td class="itemcode"><span id="OnInitFilter"></span><code>property <strong>OnInitFilter</strong> : <a href="uCEFResponseFilter.html#TOnInitFilterEvent">TOnInitFilterEvent</a> read <a href="uCEFResponseFilter.TCustomResponseFilter.html#FOnInitFilter">FOnInitFilter</a> write <a href="uCEFResponseFilter.TCustomResponseFilter.html#FOnInitFilter">FOnInitFilter</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
<p>
OnInitFilter is triggered when ICefResponseFilter.InitFilter is executed. Set the aResult parameter to install the filter. </p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0-snapshot</a>. </em>
</span>

6
docs/html/uCEFResponseFilter.html
View File

@ -21,15 +21,15 @@
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="uCEFResponseFilter.TCefResponseFilterRef.html"><code>TCefResponseFilterRef</code></a></td>
<td class="itemdesc">&nbsp;</td>
<td class="itemdesc"> Reference class implementing a resource filter. </td>
</tr>
<tr class="list2">
<td class="itemname">Class&nbsp;<a class="bold" href="uCEFResponseFilter.TCefResponseFilterOwn.html"><code>TCefResponseFilterOwn</code></a></td>
<td class="itemdesc">&nbsp;</td>
<td class="itemdesc"> Owned class implementing a resource filter. </td>
</tr>
<tr class="list">
<td class="itemname">Class&nbsp;<a class="bold" href="uCEFResponseFilter.TCustomResponseFilter.html"><code>TCustomResponseFilter</code></a></td>
<td class="itemdesc">&nbsp;</td>
<td class="itemdesc"> Custom class implementing a resource filter with events. </td>
</tr>
</table>
<span id="PasDoc-Types"></span><h3 class="summary">Types</h3>

34
source/uCEFInterfaces.pas
View File

@ -6619,7 +6619,41 @@ type
/// </remarks>
ICefResponseFilter = interface(ICefBaseRefCounted)
['{5013BC3C-F1AE-407A-A571-A4C6B1D6831E}']
/// <summary>
/// Initialize the response filter. Will only be called a single time. The
/// filter will not be installed if this function returns false (0).
/// </summary>
function InitFilter: Boolean;
/// <summary>
/// <para>Called to filter a chunk of data. Expected usage is as follows:</para>
/// <code>
/// 1. Read input data from |data_in| and set |data_in_read| to the number of
/// bytes that were read up to a maximum of |data_in_size|. |data_in| will
/// be NULL if |data_in_size| is zero.
/// 2. Write filtered output data to |data_out| and set |data_out_written| to
/// the number of bytes that were written up to a maximum of
/// |data_out_size|. If no output data was written then all data must be
/// read from |data_in| (user must set |data_in_read| = |data_in_size|).
/// 3. Return RESPONSE_FILTER_DONE if all output data was written or
/// RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.
/// </code>
/// <para>This function will be called repeatedly until the input buffer has been
/// fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| =
/// |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate
/// that output data is still pending.</para>
/// <para>Calls to this function will stop when one of the following conditions is
/// met:</para>
/// <code>
/// 1. There is no more input data to filter (the resource response is
/// complete) and the user sets |data_out_written| = 0 or returns
/// RESPONSE_FILTER_DONE to indicate that all data has been written, or;
/// 2. The user returns RESPONSE_FILTER_ERROR to indicate an error.
/// </code>
/// <para>Do not keep a reference to the buffers passed to this function.</para>
/// </summary>
function Filter(data_in: Pointer; data_in_size: NativeUInt; var data_in_read: NativeUInt; data_out: Pointer; data_out_size : NativeUInt; var data_out_written: NativeUInt): TCefResponseFilterStatus;
end;

124
source/uCEFResponseFilter.pas
View File

@ -18,24 +18,113 @@ type
TOnFilterEvent = procedure(Sender: TObject; data_in: Pointer; data_in_size: NativeUInt; var data_in_read: NativeUInt; data_out: Pointer; data_out_size : NativeUInt; var data_out_written: NativeUInt; var aResult : TCefResponseFilterStatus) of object;
TOnInitFilterEvent = procedure(Sender: TObject; var aResult : boolean) of object;
/// <summary>
/// Reference class implementing a resource filter.
/// </summary>
/// <remarks>
/// <para>The functions of this interface will be called on the browser process IO thread.</para>
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h">CEF source file: /include/capi/cef_response_filter_capi.h (cef_response_filter_t)</see></para>
/// </remarks>
TCefResponseFilterRef = class(TCefBaseRefCountedRef, ICefResponseFilter)
protected
/// <summary>
/// Initialize the response filter. Will only be called a single time. The
/// filter will not be installed if this function returns false (0).
/// </summary>
function InitFilter: Boolean; virtual;
/// <summary>
/// <para>Called to filter a chunk of data. Expected usage is as follows:</para>
/// <code>
/// 1. Read input data from |data_in| and set |data_in_read| to the number of
/// bytes that were read up to a maximum of |data_in_size|. |data_in| will
/// be NULL if |data_in_size| is zero.
/// 2. Write filtered output data to |data_out| and set |data_out_written| to
/// the number of bytes that were written up to a maximum of
/// |data_out_size|. If no output data was written then all data must be
/// read from |data_in| (user must set |data_in_read| = |data_in_size|).
/// 3. Return RESPONSE_FILTER_DONE if all output data was written or
/// RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.
/// </code>
/// <para>This function will be called repeatedly until the input buffer has been
/// fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| =
/// |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate
/// that output data is still pending.</para>
/// <para>Calls to this function will stop when one of the following conditions is
/// met:</para>
/// <code>
/// 1. There is no more input data to filter (the resource response is
/// complete) and the user sets |data_out_written| = 0 or returns
/// RESPONSE_FILTER_DONE to indicate that all data has been written, or;
/// 2. The user returns RESPONSE_FILTER_ERROR to indicate an error.
/// </code>
/// <para>Do not keep a reference to the buffers passed to this function.</para>
/// </summary>
function Filter(data_in: Pointer; data_in_size: NativeUInt; var data_in_read: NativeUInt; data_out: Pointer; data_out_size : NativeUInt; var data_out_written: NativeUInt): TCefResponseFilterStatus; virtual;
public
class function UnWrap(data: Pointer): ICefResponseFilter;
end;
/// <summary>
/// Owned class implementing a resource filter.
/// </summary>
/// <remarks>
/// <para>The functions of this interface will be called on the browser process IO thread.</para>
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h">CEF source file: /include/capi/cef_response_filter_capi.h (cef_response_filter_t)</see></para>
/// </remarks>
TCefResponseFilterOwn = class(TCefBaseRefCountedOwn, ICefResponseFilter)
protected
/// <summary>
/// Initialize the response filter. Will only be called a single time. The
/// filter will not be installed if this function returns false (0).
/// </summary>
function InitFilter: Boolean; virtual; abstract;
/// <summary>
/// <para>Called to filter a chunk of data. Expected usage is as follows:</para>
/// <code>
/// 1. Read input data from |data_in| and set |data_in_read| to the number of
/// bytes that were read up to a maximum of |data_in_size|. |data_in| will
/// be NULL if |data_in_size| is zero.
/// 2. Write filtered output data to |data_out| and set |data_out_written| to
/// the number of bytes that were written up to a maximum of
/// |data_out_size|. If no output data was written then all data must be
/// read from |data_in| (user must set |data_in_read| = |data_in_size|).
/// 3. Return RESPONSE_FILTER_DONE if all output data was written or
/// RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.
/// </code>
/// <para>This function will be called repeatedly until the input buffer has been
/// fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| =
/// |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate
/// that output data is still pending.</para>
/// <para>Calls to this function will stop when one of the following conditions is
/// met:</para>
/// <code>
/// 1. There is no more input data to filter (the resource response is
/// complete) and the user sets |data_out_written| = 0 or returns
/// RESPONSE_FILTER_DONE to indicate that all data has been written, or;
/// 2. The user returns RESPONSE_FILTER_ERROR to indicate an error.
/// </code>
/// <para>Do not keep a reference to the buffers passed to this function.</para>
/// </summary>
function Filter(data_in: Pointer; data_in_size: NativeUInt; var data_in_read: NativeUInt; data_out: Pointer; data_out_size : NativeUInt; var data_out_written: NativeUInt): TCefResponseFilterStatus; virtual; abstract;
public
constructor Create; virtual;
end;
/// <summary>
/// Custom class implementing a resource filter with events.
/// </summary>
/// <remarks>
/// <para>The functions and events of this interface will be called on the browser process IO thread.</para>
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_response_filter_capi.h">CEF source file: /include/capi/cef_response_filter_capi.h (cef_response_filter_t)</see></para>
/// </remarks>
TCustomResponseFilter = class(TCefResponseFilterOwn)
protected
FOnFilter : TOnFilterEvent;
@ -47,7 +136,42 @@ type
public
constructor Create; override;
/// <summary>
/// <para>OnFilter is triggered when ICefResponseFilter.Filter is executed to filter a chunk of data.</para>
/// <para>Expected usage is as follows:</para>
/// <code>
/// 1. Read input data from |data_in| and set |data_in_read| to the number of
/// bytes that were read up to a maximum of |data_in_size|. |data_in| will
/// be NULL if |data_in_size| is zero.
/// 2. Write filtered output data to |data_out| and set |data_out_written| to
/// the number of bytes that were written up to a maximum of
/// |data_out_size|. If no output data was written then all data must be
/// read from |data_in| (user must set |data_in_read| = |data_in_size|).
/// 3. Return RESPONSE_FILTER_DONE if all output data was written or
/// RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending.
/// </code>
/// <para>This function will be called repeatedly until the input buffer has been
/// fully read (user sets |data_in_read| = |data_in_size|) 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 |data_out_written| =
/// |data_out_size|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate
/// that output data is still pending.</para>
/// <para>Calls to this function will stop when one of the following conditions is
/// met:</para>
/// <code>
/// 1. There is no more input data to filter (the resource response is
/// complete) and the user sets |data_out_written| = 0 or returns
/// RESPONSE_FILTER_DONE to indicate that all data has been written, or;
/// 2. The user returns RESPONSE_FILTER_ERROR to indicate an error.
/// </code>
/// <para>Do not keep a reference to the buffers passed to this function.</para>
/// </summary>
property OnFilter : TOnFilterEvent read FOnFilter write FOnFilter;
/// <summary>
/// OnInitFilter is triggered when ICefResponseFilter.InitFilter is executed.
/// Set the aResult parameter to install the filter.
/// </summary>
property OnInitFilter : TOnInitFilterEvent read FOnInitFilter write FOnInitFilter;
end;

2
update_CEF4Delphi.json
View File

@ -2,7 +2,7 @@
"UpdateLazPackages" : [
{
"ForceNotify" : true,
"InternalVersion" : 584,
"InternalVersion" : 585,
"Name" : "cef4delphi_lazarus.lpk",
"Version" : "123.0.13"
}