abstract task util More...

#include <ZFTask.h>

Inheritance diagram for ZFTask:

Public Types
enum

Public Types inherited from ZFObject
enum

Public Member Functions
virtual const ZFClass *	classData (void)
	get instance's class info

virtual void	start (const ZFListener &onStop=(zft_zfnull))
	start the task

virtual void	stop (void)
	stop task

virtual void	stop (ZFResultType resultType)
	stop the task

virtual zfbool	started ()
	whether task running

virtual void	notifySuccess (ZFObject *result=(zft_zfnull))
	util method to call stop with success result

virtual void	notifyFail (const zfstring &errorHint, ZFObject *result=(zft_zfnull))
	util method to call stop with fail result

virtual zfany const &	result ()
	for task impl to store task result, actual result depends on task, reset to null when start

virtual void	result (zfany const &propertyValue)
	see result

virtual ZFResultType &	resultType ()
	for task impl to store task result, reset to success when start

virtual void	resultType (ZFResultType const &propertyValue)
	see resultType

virtual zfstring &	errorHint ()
	for task impl to store error hint, reset when start

virtual void	errorHint (zfstring const &propertyValue)
	see errorHint

virtual void	taskOnStart (void)
	called to start task

virtual void	taskOnStop (ZFResultType resultType)
	called to stop task

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

Public Member Functions inherited from ZFInterface
virtual ZFObject *	toObject (void)=0
	convert to ZFObject type

Static Public Member Functions
static const ZFClass *	ClassData (void)
	get class info

static zfidentity	E_TaskOnStart (void)
	called when task started

static zfidentity	E_TaskOnStop (void)
	called when task started

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

Static Public Member Functions inherited from ZFTaskId
static const ZFClass *	ClassData (void)
	get class info

Static Public Member Functions inherited from ZFInterface
static const ZFClass *	ClassData (void)
	get class info

Protected Types
typedef ZFObject	zfsuper
	class ref to super

typedef ZFTask	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 Types inherited from ZFTaskId
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFTaskId	zfself
	typedef for self

Protected Types inherited from ZFInterface
typedef _ZFP_ObjI_Base	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFInterface	zfself
	typedef for self

Protected Member Functions
virtual void	objectOnInit (const ZFListener &implOnStart, const ZFListener &implOnStop=(zft_zfnull))
	util constructor to attach custom impl to E_TaskOnStart and E_TaskOnStop

virtual void	objectOnInit (void)
	override this to init your object

virtual void	objectOnDeallocPrepare (void)
	called before objectOnDealloc, safe to call virtual functions here

virtual void	objectInfoImpl (zfstring &ret)
	see objectInfo

Protected Member Functions inherited from ZFObject
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	objectOnDealloc (void)
	override this to destroy your object

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

Detailed Description

abstract task util

Member Function Documentation

◆ classData()

virtual const ZFClass * ZFTask::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFObject.

Reimplemented in ZFAniTask, ZFAsyncIOCustomTask, ZFAsyncIOTask, ZFAsyncTask, ZFAudioPlayTask, ZFIOCacheLoadTask, ZFPostTask, ZFTaskGroup, ZFTaskQueue, ZFUIImageLoadTask, and ZFWaitTask.

◆ E_TaskOnStart()

static zfidentity ZFTask::E_TaskOnStart ( void )

static

called when task started

◆ E_TaskOnStop()

static zfidentity ZFTask::E_TaskOnStop ( void )

static

called when task started

param0 is a ZFResultType to show the result

◆ start()

virtual void ZFTask::start ( const ZFListener & onStop = (zft_zfnull) )

virtual

start the task

impl must call stop or notifySuccess or notifyFail when task done, by any of these methods:

override taskOnStart
attach observer to E_TaskOnStart

the task object would be retained during running

◆ stop()

virtual void ZFTask::stop ( void )

inlinevirtual

stop task

Implements ZFTaskId.

◆ taskOnStart()

virtual void ZFTask::taskOnStart ( void )

inlinevirtual

called to start task

Reimplemented in ZFAniTask, ZFAsyncIOCustomTask, ZFAsyncIOTask, ZFAsyncTask, ZFAudioPlayTask, ZFIOCacheLoadTask, ZFPostTask, ZFTaskGroup, ZFTaskQueue, ZFUIImageLoadTask, and ZFWaitTask.

◆ taskOnStop()

virtual void ZFTask::taskOnStop ( ZFResultType resultType )

inlinevirtual

called to stop task

Reimplemented in ZFAniTask, ZFAsyncIOCustomTask, ZFAsyncIOTask, ZFAsyncTask, ZFAudioPlayTask, ZFIOCacheLoadTask, ZFPostTask, ZFTaskGroup, ZFTaskQueue, ZFUIImageLoadTask, and ZFWaitTask.

◆ objectOnInit()

virtual void ZFTask::objectOnInit ( void )

inlineprotectedvirtual

override this to init your object

subclass must call superclass's objectOnInit before any other code if override
you may also declare objectOnInit with params like this:

zfclass Parent : ... {
    ...
protected:
    virtual void objectOnInit(void) {...};
};
zfclass Child : Parent {
protected:
    // override all parent's objectOnInit is also required,
    // because of function hiding of C++
    zfoverride
    virtual void objectOnInit(void) {
        zfsuper::objectOnInit();
    }
    // custom init entry
    virtual void objectOnInit(Params...) {
        // your extra init steps
        ...
    }
};

Warning: objectOnInit and objectOnDealloc is called as a virtual function, take good care of other virtual function call, use zfself::func() instead of this->func() if necessary, or use objectOnInitFinish/objectOnDeallocPrepare, or declare your own constructor with ZFOBJECT_DECLARE_WITH_CUSTOM_CTOR

Note: (ZFTAG_LIMITATION) due to limitations of C++, if your parent type declared objectOnInit with different params, and your child type want to override part of those objectOnInit, then your child type must also override all objectOnInit that parent declared, otherwise, some may be hidden; for objects that designed not to be allocated by user, you should use ZFOBJECT_PRIVATE_ALLOC, typically usage:
zfclass MyObject : zfextend ZFObject {

ZFOBJECT_DECLARE(MyObject, ZFObject)

ZFOBJECT_PRIVATE_ALLOC("should be created by MyObject::instanceForXxx only")

public:

static zfauto instanceForXxx(xxx) {

// can only be allocated by reflection

return zfself::ClassData()->newInstance();

}

};

static void func(void) {

// MyObject *obj = zfAlloc(MyObject); // would compile error

zfauto obj = MyObject::instanceForXxx(xxx); // OK

}

zfextend
#define zfextend
dummy macro shows class inherit from another
Definition ZFCoreTypeDef_ClassType.h:53

ZFOBJECT_DECLARE
#define ZFOBJECT_DECLARE(ChildClass, SuperClass,...)
necessary for every class inherit from ZFObject
Definition ZFObjectDeclare.h:126

ZFOBJECT_PRIVATE_ALLOC
#define ZFOBJECT_PRIVATE_ALLOC(...)
mark this object can not be allocated directly
Definition ZFObjectDeclare.h:245

ZFClass::newInstance
zfauto newInstance(void) const
make a new instance of ZFObject dynamically, which is described by ZFClass

ZFTask::ClassData
static const ZFClass * ClassData(void)
get class info
Definition ZFTask.h:16

zfauto
a ZFObject holder which would release content object automatically when destroyed
Definition zfautoFwd.h:34

Reimplemented from ZFObject.

Reimplemented in ZFAniTask, ZFAsyncIOCustomTask, ZFAsyncIOTask, ZFAsyncTask, ZFAudioPlayTask, ZFIOCacheLoadTask, ZFPostTask, ZFUIImageLoadTask, and ZFWaitTask.

◆ objectOnDeallocPrepare()

virtual void ZFTask::objectOnDeallocPrepare ( void )

inlineprotectedvirtual

called before objectOnDealloc, safe to call virtual functions here

usually used to cleanup resources attached to this object other than self's internal resources

Note: it's ensured safe to retain the object while deallocating, but it's not ensured objectOnDeallocPrepare would only called once for each instance

Reimplemented from ZFObject.

◆ objectInfoImpl()

virtual void ZFTask::objectInfoImpl ( zfstring & ret )

protectedvirtual

see objectInfo

Reimplemented from ZFObject.

Reimplemented in ZFAniTask, ZFTaskGroup, and ZFTaskQueue.

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

ZFTask.h

ZFFramework

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Function Documentation

◆ classData()

◆ E_TaskOnStart()

◆ E_TaskOnStop()

◆ start()

◆ stop()

◆ taskOnStart()

◆ taskOnStop()

◆ objectOnInit()

◆ objectOnDeallocPrepare()

◆ objectInfoImpl()