foxit.common.file.AsyncReaderCallback Class Reference

Inherits foxit.common.fxcrt.FileReaderCallback.

Public Member Functions

virtual bool AddDownloadHint (long offset, uint size)
 A callback function used to add offset and size to specify a data section, which should be downloaded by application then. More...
 
virtual bool IsDataAvail (long offset, uint size)
 A callback function used to check whether the specified data section is available or not. More...
 

Detailed Description

This class represents a callback object to do file reading asynchronously. This class is derived from class ReaderCallback. 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
ReaderCallback

Member Function Documentation

◆ AddDownloadHint()

bool foxit.common.file.AsyncReaderCallback.AddDownloadHint ( long  offset,
uint  size 
)
inlinevirtual

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
offsetThe offset of a data section, which is to be hinted.
sizeThe size of the data section.
Returns
true means success, while false means failure.

◆ IsDataAvail()

bool foxit.common.file.AsyncReaderCallback.IsDataAvail ( long  offset,
uint  size 
)
inlinevirtual

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
offsetThe offset in file.
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.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.