Public Member Functions | List of all members
Celartem::StorageLoader Class Referenceabstract

#include <cel_storagecache.h>

Inheritance diagram for Celartem::StorageLoader:
Inheritance graph
[legend]

Public Member Functions

virtual StorageRange load (Storage *inStorage, uint64_t inPos, size_t inSize)=0
 
virtual uint64_t getSize () const =0
 
virtual String getStorageId () const =0
 
virtual Time getLastUpdateTime () const =0
 
virtual AutoPtr< StorageLoaderduplicate () const =0
 
virtual void setBufferingSize (size_t inSize=1024)=0
 
virtual void setCallback (DuplicateStreamCallback inCallback, void *inContext)=0
 
- Public Member Functions inherited from Celartem::Referable
 Referable ()
 
void addRef () const
 
void releaseRef () const
 
size_t getReferenceCount () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Celartem::Referable
static void dumpDbgAllRefCount ()
 

Detailed Description

This class defines loader class which is used with AdvCachedStorage.

Member Function Documentation

virtual AutoPtr<StorageLoader> Celartem::StorageLoader::duplicate ( ) const
pure virtual

Duplicate the instance.

Returns
The newly created StorageLoader instance.
virtual Time Celartem::StorageLoader::getLastUpdateTime ( ) const
pure virtual

This method returns the last update time of the file.

Returns
The last update time.
virtual uint64_t Celartem::StorageLoader::getSize ( ) const
pure virtual

Return the size of the storage.

Returns
The size of the storage.
If the size is not known, this method should return 0xffffffffffffffff.
virtual String Celartem::StorageLoader::getStorageId ( ) const
pure virtual

Return the identifier of the storage.

Returns
The identifier (usually an URI).
virtual StorageRange Celartem::StorageLoader::load ( Storage inStorage,
uint64_t  inPos,
size_t  inSize 
)
pure virtual

Load a range of storage which contains the range specified by inPos and inSize.

Parameters
inStorageStorage to written on.
inPosThe position of the storage range.
inSizeThe size of the storage range.
Returns
The range actually loaded by this call.
virtual void Celartem::StorageLoader::setBufferingSize ( size_t  inSize = 1024)
pure virtual

Set the buffering size. The buffering size has very large impact on the networking performance.

Parameters
inSizeBuffering size in bytes. The default is 1024 bytes.
virtual void Celartem::StorageLoader::setCallback ( DuplicateStreamCallback  inCallback,
void *  inContext 
)
pure virtual

Set the callback which is called when calls to load take long.

Parameters
inCallbackPointer to a callback function.
inContextContext for the callback function.

The documentation for this class was generated from the following file:

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:06.
Cuminas Logo