ZFTaskQueue Class Reference

queue of ZFTask, all task run sequencely More...

#include <ZFTaskQueue.h>

Inheritance diagram for ZFTaskQueue:

Public Types
enum
Public Types inherited from ZFTask
enum
Public Types inherited from ZFObject
enum

Public Member Functions
virtual const ZFClass *	classData (void)
	get instance's class info
virtual void	child (ZFTask *child)
	add child
virtual void	child (const ZFListener &implStart, const ZFListener &implStop=(zft_zfnull))
	util to add child task
virtual void	wait (zftimet duration)
	util to add ZFWaitTask
virtual zfindex	childCount ()
	child count
virtual zfanyT< ZFTask >	childAt (zfindex index)
	child at index
virtual zfautoT< ZFTask >	childRemoveAt (zfindex index)
	child remove at index
virtual void	childRemoveAll ()
	remove all child
virtual zfanyT< ZFArray > const &	childArray ()
	child array
Public Member Functions inherited from ZFTask
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 zfbool	success ()
	util to check resultType
virtual zfbool	canceled ()
	util to check resultType
virtual zfbool	failed ()
	util to check resultType
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	taskPending (zfbool pending)
	make the task pending
Public Member Functions inherited from ZFObject
const ZFClass *	classDynamic (void)
	dynamic class of this object, see ZFClassDynamicRegister
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_ChildOnStart (void)
	called when child task started
static zfidentity	E_ChildOnStop (void)
	called when child task stopped
Static Public Member Functions inherited from ZFTask
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 stopped
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 ZFTask	zfsuper
	class ref to super
typedef ZFTaskQueue	zfself
	class ref to self
Protected Types inherited from ZFTask
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	childArray (zfanyT< ZFArray > const &propertyValue)
	see childArray
virtual void	childOnStart (ZFTask *child)
	see E_ChildOnStart
virtual void	childOnStop (ZFTask *child)
	see E_ChildOnStop
virtual void	taskOnStart (void)
	called to start task
virtual void	taskOnStop (void)
	called to stop task
virtual void	objectInfoImpl (zfstring &ret)
	see objectInfo
Protected Member Functions inherited from ZFTask
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
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

queue of ZFTask, all task run sequencely

Member Function Documentation

classData()

virtual const ZFClass * ZFTaskQueue::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFTask.

E_ChildOnStart()

zfidentity ZFTaskQueue::E_ChildOnStart ( void )

static

called when child task started

sender is the owner task queue, param0 is the child task

E_ChildOnStop()

zfidentity ZFTaskQueue::E_ChildOnStop ( void )

static

called when child task stopped

sender is the owner task queue, param0 is the child task

taskOnStart()

virtual void ZFTaskQueue::taskOnStart ( void )

protectedvirtual

called to start task

Reimplemented from ZFTask.

taskOnStop()

virtual void ZFTaskQueue::taskOnStop ( void )

protectedvirtual

called to stop task

Reimplemented from ZFTask.

objectInfoImpl()

virtual void ZFTaskQueue::objectInfoImpl ( zfstring & ret )

protectedvirtual

see objectInfo

Reimplemented from ZFTask.

---

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

• ZFTaskQueue.h