ZFIOCache Class Reference

cache config and holder for ZFIOCacheLoad More...

#include <ZFIOCache.h>

Inheritance diagram for ZFIOCache:

Public Types
enum
Public Types inherited from ZFCache
enum
Public Types inherited from ZFObject
enum

Public Member Functions
virtual const ZFClass *	classData (void)
	get instance's class info
virtual zfanyT< ZFSet > const &	localCacheExclude ()
	a list of path type which should not stored as local cache
virtual zfindex &	localCacheMaxSize ()
	max local cache count to keep
virtual void	localCacheMaxSize (zfindex const &propertyValue)
	see localCacheMaxSize
virtual zftimet &	localCacheTime ()
	cache time in miliseconds
virtual void	localCacheTime (zftimet const &propertyValue)
	see localCacheTime
virtual ZFPathInfo &	localCachePathInfo ()
	override default cache path
virtual void	localCachePathInfo (ZFPathInfo const &propertyValue)
	see localCachePathInfo
virtual ZFPathInfo	localCachePathInfoFixed ()
	return a fixed path info of localCachePathInfo
virtual ZFPathInfo	localCachePathInfoForChild (const zfchar *childPath)
	util method to get a cache file under localCachePathInfo
Public Member Functions inherited from ZFCache
virtual zfindex &	cacheMaxSize ()
	max cache size, 10 by default
virtual void	cacheMaxSize (zfindex const &propertyValue)
	see cacheMaxSize
virtual zfbool &	cacheTrimWhenMemoryLow ()
	whether invoke cacheTrim when receive ZFGlobalEvent::E_AppOnMemoryLow, true by default
virtual void	cacheTrimWhenMemoryLow (zfbool const &propertyValue)
	see cacheTrimWhenMemoryLow
virtual zffloat &	cacheTrimThreshold ()
	leave how many cache alive while cacheTrimWhenMemoryLow, 0.2 by default
virtual void	cacheTrimThreshold (zffloat const &propertyValue)
	see cacheTrimThreshold
virtual void	cacheAdd (const zfstring &cacheKey, ZFObject *cacheValue)
	add cache
virtual zfauto	cacheGet (const zfstring &cacheKey)
	access and remove cache, or return null if not exist, see cacheCheck
virtual zfauto	cacheCheck (const zfstring &cacheKey)
	check cache, or return null if not exist, see cacheGet
virtual void	cacheRemove (const zfstring &cacheKey)
	remove all cache with cacheKey
virtual void	cacheRemoveAll ()
	remove all cache
virtual void	cacheTrim (zfindex size)
	util method to trim the cache so that the cached data won't exceeds specified size
virtual void	cacheGetAllT (ZFCoreArray< zfstring > &cacheKeyList, ZFCoreArray< zfauto > &cacheValueList)
	access all cache data, used for debug only
Public Member Functions inherited from ZFObject
zfindex	objectRetainCount (void)
	return the object's retain count
void	objectInfoOfInstanceT (zfstring &ret)
	see objectInfoOfInstance
zfstring	objectInfoOfInstance (void)
	return a short string describe the object instance
void	objectInfoT (zfstring &ret)
	see objectInfo
zfstring	objectInfo (void)
	return object info
zfidentity	objectHash (void)
	get hash of this object
ZFCompareResult	objectCompare (ZFObject *anotherObj)
	compare with anotherObj
ZFCompareResult	objectCompareValue (ZFObject *anotherObj)
	explicitly compare object by logical value, see objectCompare
virtual zfauto	invoke (const zfstring &methodName)
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfauto	invoke (const zfstring &methodName, ZFObject *param0, ZFObject *param1=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param2=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param3=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param4=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param5=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param6=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param7=((ZFObject *const &) _ZFP_ZFMP_DEF))
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfbool	invokeT (zfauto &ret, zfstring *errorHint, const zfstring &methodName, ZFObject *param0=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param1=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param2=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param3=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param4=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param5=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param6=((ZFObject *const &) _ZFP_ZFMP_DEF), ZFObject *param7=((ZFObject *const &) _ZFP_ZFMP_DEF))
	util method to perform ZFDI_invoke, do nothing if fail
virtual zfauto	invokeDetail (const zfstring &methodName, const ZFCoreArray< zfauto > &params, zfbool *success=zft_zfnull, zfstring *errorHint=zft_zfnull)
	util method to perform ZFDI_invoke, do nothing if fail
zfbool	objectTagExist (void)
	see objectTag, true if this object has tag, and tag can be checked by objectTagGetAllKeyValue
void	objectTag (const zfstring &key, ZFObject *tag)
	used to hold a object for app's use, auto retained
zfany	objectTag (const zfstring &key)
	see objectTag
void	objectTagGetAllKeyValue (ZFCoreArray< zfstring > &allKey, ZFCoreArray< zfauto > &allValue)
	get all key value
void	objectTagRemove (const zfstring &key)
	remove tag, same as set tag to null
zfauto	objectTagRemoveAndGet (const zfstring &key)
	remove tag, return removed tag or null if not exist
void	objectTagRemoveAll (void)
	remove all tag
void	observerAdd (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify
void	observerAddForOnce (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify
void	observerRemove (zfidentity eventId, const ZFListener &callback)
	see observerNotify
void	observerRemoveAll (zfidentity eventId)
	see observerNotify
void	observerRemoveAll (void)
	see observerNotify
zfbool	observerHasAdd (void)
	true if any observer has been added
zfbool	observerHasAdd (zfidentity eventId)
	true if any observer with eventId has been added
void	observerNotify (zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	notify the observer with eventId
void	observerNotifyWithSender (ZFObject *customSender, zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
void	observerNotifyReversely (zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
void	observerNotifyReverselyWithSender (ZFObject *customSender, zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
	see observerNotify
ZFObserver &	observerHolder (void)
	access the internal observer holder
void	on (const zfstring &eventName, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	util to observerAdd
void	on (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	util to observerAdd
void	onInit (const ZFListener &impl)
	util for script to achieve chained call
void	onDealloc (const ZFListener &impl)
	util for script to achieve chained call
zfbool	objectInstanceStateCheck (ZFObjectInstanceState state)
	object instance's state
zfbool	objectInitRunning (void)
	util method to check whether ZFObjectInstanceStateOnInit or ZFObjectInstanceStateOnInitFinish running
zfbool	objectDeallocRunning (void)
	util method to check whether ZFObjectInstanceStateOnDeallocPrepare or ZFObjectInstanceStateOnDealloc running
virtual zfbool	objectIsInternal (void)
	whether this object is internal object or its class is ZFClass::classIsInternal
virtual zfbool	objectIsInternalPrivate (void)
	whether this object is internal private object or its class is ZFClass::classIsInternalPrivate

Static Public Member Functions
static const ZFClass *	ClassData (void)
	get class info
static ZFIOCache *	instance ()
Static Public Member Functions inherited from ZFCache
static const ZFClass *	ClassData (void)
	get class info
static zfidentity	E_CacheOnAdd (void)
	see ZFObject::observerNotify
static zfidentity	E_CacheOnRemove (void)
	see ZFObject::observerNotify
Static Public Member Functions inherited from ZFObject
static const ZFClass *	ClassData (void)
	get class info
static zfidentity	E_ObjectBeforeAlloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectAfterAlloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectBeforeDealloc (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectPropertyValueOnUpdate (void)
	see ZFObject::observerNotify
static zfidentity	E_ObjectPropertyValueOnReset (void)
	see ZFObject::observerNotify

Protected Types
typedef ZFCache	zfsuper
	class ref to super
typedef ZFIOCache	zfself
	class ref to self
Protected Types inherited from ZFCache
typedef ZFObject	zfsuper
	class ref to super
typedef ZFCache	zfself
	class ref to self
Protected Types inherited from ZFObject
typedef _ZFP_Obj_Base	zfsuper
	class ref to super
typedef ZFObject	zfself
	class ref to self

Protected Member Functions
virtual void	localCacheExclude (zfanyT< ZFSet > const &propertyValue)
	see localCacheExclude
Protected Member Functions inherited from ZFCache
virtual void	cacheOnAdd (ZFObject *cache)
	see E_CacheOnAdd
virtual void	cacheOnRemove (ZFObject *cache)
	see E_CacheOnRemove
virtual void	objectOnInit (void)
	override this to init your object
virtual void	objectOnDealloc (void)
	override this to destroy your object
virtual void	objectOnDeallocPrepare (void)
	called before objectOnDealloc, safe to call virtual functions here
Protected Member Functions inherited from ZFObject
virtual void	objectInfoImpl (zfstring &ret)
	see objectInfo
virtual void	objectInfoImplAppend (zfstring &ret)
	see objectInfo
virtual zfidentity	objectHashImpl (void)
	see objectHash
virtual ZFCompareResult	objectCompareImpl (ZFObject *anotherObj)
	see objectCompare
virtual ZFCompareResult	objectCompareValueImpl (ZFObject *anotherObj)
	see objectCompareValue
virtual void	observerOnAdd (zfidentity eventId)
	called when add first observer
virtual void	observerOnRemove (zfidentity eventId)
	called when remove last observer
virtual void	observerOnEvent (const ZFArgs &zfargs)
	notified when observerNotify
virtual void	objectOnInitFinish (void)
	called after objectOnInit, safe to call virtual functions here
virtual void	objectOnRetain (void)
	called to retain object
virtual void	objectOnRelease (void)
	called to release object
virtual void	objectPropertyValueOnUpdate (const ZFProperty *property, const void *oldValue)
	see E_ObjectPropertyValueOnUpdate
virtual void	objectPropertyValueOnReset (const ZFProperty *property)
	see E_ObjectPropertyValueOnReset

Static Protected Member Functions
static void	instance (ZFIOCache *param0)
	see instance

Detailed Description

cache config and holder for ZFIOCacheLoad

Member Function Documentation

classData()

virtual const ZFClass * ZFIOCache::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFCache.

instance()

static ZFIOCache * ZFIOCache::instance ( )

static

access singleton instance

localCacheExclude()

virtual zfanyT< ZFSet > const & ZFIOCache::localCacheExclude ( )

inlinevirtual

a list of path type which should not stored as local cache

by default, temp file would be stored as local cache file to speed up next time load, which is not necessary for files already stored in local, you may add them (as v_zfstring) to this config to prevent extra local file cache logic, see ZFPATHTYPE_DECLARE

localCachePathInfo()

virtual ZFPathInfo & ZFIOCache::localCachePathInfo ( )

inlinevirtual

override default cache path

the path info must support:

• ZFInputForPathInfo / ZFOutputForPathInfo
• ZFPathInfoFindFirst series

---

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

• ZFIOCache.h