Foxit PDF SDK
FSDK.AsyncReaderCallback Class Reference

Public Member Functions

 AddDownloadHint (offset, size)
 A callback function used to add offset and size to specify a data section, which should be downloaded by application then. More...
 
 GetSize ()
 Get total size of the file. More...
 
ReadBlock(offset, size) IsDataAvail (offset, size)
 Read a data block from the file. More...
 
 Release ()
 Called when to release everything. More...
 

Detailed Description

This class represents a callback object to do file reading asynchronously. This class is derived from class FSDK.FileReaderCallback. All the pure virtual functions in this class and its base class are used as callback functions and should be implemented by user, in order to asynchronously read file data (especially used for loading document), in a customized way.

See also
FSDK.FileReaderCallback

Member Function Documentation

◆ AddDownloadHint()

FSDK.AsyncReaderCallback.AddDownloadHint ( offset  ,
size   
)

A callback function used to add offset and size to specify a data section, which should be downloaded by application then.

Foxit PDF SDK would call this callback function to report downloading hints for the download manager of application.
The position (as offset) and size of the section may not be accurate because part of the section might already be available. The download manager must manage this to maximize download efficiency.

Parameters
[in]offsetThe offset of a data section, which is to be hinted.
[in]sizeThe size of the data section.
Returns
true means success, while false means failure.

◆ GetSize()

FSDK.AsyncReaderCallback.GetSize ( )

Get total size of the file.

Returns
File size, in bytes. Implementation can return 0 for any error.

◆ IsDataAvail()

ReadBlock (offset, size) FSDK.AsyncReaderCallback.IsDataAvail ( offset  ,
size   
)

Read a data block from the file.

Parameters
[in]offsetByte offset from beginning of the file
[in]sizeNumber of bytes for the block.
Returns
Returns a tuple, the first element is a boolean value, true means success, and false means failure. The second element is a buffer receiving read data.

A callback function used to check whether the specified data section is available or not.

A data section is available only if all bytes in the section are available.

Parameters
[in]offsetThe offset in file.
[in]sizeThe size of the data section, which is to be checked if available.
Returns
true means the specified data section is available, while false means the specified data section is not available yet.

◆ Release()

FSDK.AsyncReaderCallback.Release ( )

Called when to release everything.

Returns
None.