Yate
ScriptAsync Class Referenceabstract

Asynchronous execution support. More...

#include <yatescript.h>

Inheritance diagram for ScriptAsync:
GenObject

Public Member Functions

 ScriptAsync (ScriptRun *owner)
 
virtual ~ScriptAsync ()
 
ScriptRunrunner ()
 
virtual bool run ()=0
 
- Public Member Functions inherited from GenObject
 GenObject ()
 
virtual ~GenObject ()
 
virtual bool alive () const
 
virtual void destruct ()
 
virtual const StringtoString () const
 
virtual const StringtraceId () const
 
virtual void * getObject (const String &name) const
 
NamedCountergetObjCounter () const
 
NamedCountersetObjCounter (NamedCounter *counter)
 

Additional Inherited Members

- Static Public Member Functions inherited from GenObject
static void * getObject (const String &name, const GenObject *obj)
 
static bool getObjCounting ()
 
static void setObjCounting (bool enable)
 
static NamedCountergetObjCounter (const String &name, bool create=true)
 
static ObjListgetObjCounters ()
 

Detailed Description

Asynchronous execution support.

Operation that is to be executed by the script runtime before current operation

Constructor & Destructor Documentation

◆ ScriptAsync()

ScriptAsync ( ScriptRun * owner)
inline

Constructor

Parameters
ownerThe script running instance that will own this operation

◆ ~ScriptAsync()

virtual ~ScriptAsync ( )
inlinevirtual

Destructor

Member Function Documentation

◆ run()

virtual bool run ( )
pure virtual

Execute the aynchronous operation with context unlocked if the script is paused

Returns
True if the operation should be removed (was one-shot)

◆ runner()

ScriptRun * runner ( )
inline

Retrieve the script running instance that owns this stack

Returns
Pointer to owner script instance

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