TransferBeforeScanEnding

March 5, 2024

ID 201208

Specifies Partial mode (Data Trickling) for the files that are sent to the proxy server. This mode allows the scanning of files as a whole and partially sending them to a user before the scan is finished. Object transferring starts after as many seconds after the object receiving starts as specified in the Delay attribute and is performed in chunks. Notice that no more than one chunk per second is transferred. This feature is necessary to prevent a user's browser from interrupting the connection to the proxy server due to the timeout.

Path

ICAPSettings > TransferBeforeScanEnding

Attributes

This element has the following attributes.

TransferBeforeScanEnding element attributes

Attribute

Description

Delay

The interval (in seconds) between the start of receiving an object and the start of sending its first chunk.

Optional attribute. The range of possible values is from 1 to 3600.

The preset value is 10.

ChunkSize

Size of the transferred chunks in the period between the start of receiving the object and the end of scanning. Since chunks are transferred no more than one per second, ChunkSize specifies the maximum transfer speed (in kilobytes per second) until the scan is completed. After that, if the object is clean, the rest of the object transfers without a speed limit.

Optional attribute. The range of possible values is from 1 to 1024.

The preset value is 4.

BlockedUrlCacheEnabled

Specifies how re-download attempts from a user's browser must be handled in the Partial mode. This feature is necessary to prevent a user's browser from automatically re-downloading the blocked files. The re-downloading prevention mechanism works only when the TransferBeforeScanEnding option is enabled.

You can specify one of the following values for the attribute:

  • 0

    Re-downloading prevention mechanism is disabled.

  • 1

    Re-downloading prevention mechanism is enabled. This value is preset.

If this attribute is omitted, the re-downloading prevention mechanism is enabled.

BlockedUrlCacheKb

Maximum cache size for blocked URLs, in KB. This is the maximum amount of RAM that can be allocated for a blocked URL's cache.

The range of possible values is from 1 to 100000.

The preset value is 5000.

If this attribute is omitted, the preset value is used.

BlockedUrlCacheTtlSec

Lifetime for blocked URLs in the cache, in seconds.

The range of possible values is from 1 to 604800 (one week).

The preset value is 1800.

If this attribute is omitted, the preset value is used.

Choose the appropriate values for the ChunkSize and the Delay attributes. Therefore, it is not recommended to specify a too large ChunkSize value and a too small Delay value. If this recommendation is not followed, the scanned object can be sent almost wholly (without the last chunk) long before the end of the scan and the user's browser will interrupt the connection.

Possible values

This element has the following possible values.

TransferBeforeScanEnding element possible values

Value

Description

0

The file is sent only after the scanning ends.

This value is preset.

1

The file can be sent before the scanning ends.

Example

The following is an example of this element.

<TransferBeforeScanEnding Delay="10" ChunkSize="4" BlockedURLCacheEnabled="1" BlockedURLCacheKb="5000" BlockedURLCacheTtlSec="1800">1</TransferBeforeScanEnding>

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.