ZFState.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFState_h_
#define _ZFI_ZFState_h_
 
#include "ZFUtilityDef.h"
 
ZF_NAMESPACE_GLOBAL_BEGIN
 
zfclassFwd _ZFP_ZFStatePrivate;
zfclass ZFLIB_ZFUtility ZFState : zfextend ZFObject {
    ZFOBJECT_DECLARE(ZFState, ZFObject)
    ZFOBJECT_SINGLETON_DECLARE(ZFState, instance)
 
public:
    // ============================================================
    // events
    ZFEVENT(StateFileUpdate)
 
public:
    ZFMETHOD_DECLARE_STATIC_0(ZFPathInfo, stateFileDefault)

    ZFPROPERTY_ASSIGN(ZFPathInfo, stateFile)
    ZFPROPERTY_ON_ATTACH_DECLARE(ZFPathInfo, stateFile)
    ZFMETHOD_DECLARE_0(ZFPathInfo, stateFileFixed)
 
public:
    ZFMETHOD_DECLARE_0(zfbool, ready)
    ZFMETHOD_DECLARE_1(zfautoT<ZFTaskId>, load
            , ZFMP_IN(const ZFListener &, callback)
            )
    ZFMETHOD_DECLARE_1(zfautoT<ZFTaskId>, save
            , ZFMP_IN(const ZFListener &, callback)
            )

    ZFMETHOD_DECLARE_0(void, saveImmediately)

    ZFMETHOD_DECLARE_3(void, set
            , ZFMP_IN(const zfstring &, key)
            , ZFMP_IN(const zfstring &, value)
            , ZFMP_IN_OPT(zftimet, expire, 0)
            )
    ZFMETHOD_DECLARE_1(void, remove
            , ZFMP_IN(const zfstring &, key)
            )
    ZFMETHOD_DECLARE_0(void, removeAll)

    ZFMETHOD_DECLARE_1(zfstring, get
            , ZFMP_IN(const zfstring &, key)
            )
    ZFMETHOD_DECLARE_2(zfautoT<ZFTaskId>, getAsync
            , ZFMP_IN(const zfstring &, key)
            , ZFMP_IN(const ZFListener &, callback)
            )

    ZFMETHOD_DECLARE_2(void, update
            , ZFMP_IN(const zfstring &, key)
            , ZFMP_IN_OPT(zftimet, expire, 0)
            )

    ZFMETHOD_DECLARE_0(zfautoT<ZFHashMap>, getAll)
    ZFMETHOD_DECLARE_2(void, getAllT
            , ZFMP_IN_OUT(ZFCoreArray<zfstring> &, keys)
            , ZFMP_IN_OUT(ZFCoreArray<zfstring> &, values)
            )
 
protected:
    zfoverride
    virtual void objectOnInit(void);
    zfoverride
    virtual void objectOnDealloc(void);
 
private:
    _ZFP_ZFStatePrivate *d;
    friend zfclassFwd _ZFP_ZFStatePrivate;
};
 
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFState_h_