AsyncWorkerThread Class Reference

#include <s_async.h>

Inheritance diagram for AsyncWorkerThread:

Collaboration diagram for AsyncWorkerThread:

Public Member Functions
	AsyncWorkerThread (AsyncEngine *jobDispatcher, const std::string &name)
virtual	~AsyncWorkerThread ()
void *	run ()
Public Member Functions inherited from Thread
	Thread (const std::string &name="")
virtual	~Thread ()
bool	start ()
bool	stop ()
bool	wait ()
bool	isCurrentThread ()
bool	isRunning ()
bool	stopRequested ()
std::thread::id	getThreadId ()
bool	getReturnValue (void **ret)
bool	bindToProcessor (unsigned int proc_number)
bool	setPriority (int prio)
Public Member Functions inherited from ScriptApiBase
	ScriptApiBase (ScriptingType type)
	ScriptApiBase ()
virtual	~ScriptApiBase ()
	DISABLE_CLASS_COPY (ScriptApiBase)
void	loadMod (const std::string &script_path, const std::string &mod_name)
void	loadScript (const std::string &script_path)
void	loadModFromMemory (const std::string &mod_name)
void	runCallbacksRaw (int nargs, RunCallbacksMode mode, const char *fxn)
void	addObjectReference (ServerActiveObject *cobj)
void	removeObjectReference (ServerActiveObject *cobj)
IGameDef *	getGameDef ()
Server *	getServer ()
ScriptingType	getType ()
Client *	getClient ()
std::string	getOrigin ()
void	setOriginDirect (const char *origin)
void	setOriginFromTableRaw (int index, const char *fxn)
void	clientOpenLibs (lua_State *L)

Private Attributes
AsyncEngine *	jobDispatcher = nullptr

Additional Inherited Members
Static Public Member Functions inherited from Thread
static void	setName (const std::string &name)
static unsigned int	getNumberOfProcessors ()
Protected Member Functions inherited from ScriptApiBase
lua_State *	getStack ()
void	realityCheck ()
void	scriptError (int result, const char *fxn)
void	stackDump (std::ostream &o)
void	setGameDef (IGameDef *gamedef)
Environment *	getEnv ()
void	setEnv (Environment *env)
GUIEngine *	getGuiEngine ()
void	setGuiEngine (GUIEngine *guiengine)
void	objectrefGetOrCreate (lua_State *L, ServerActiveObject *cobj)
void	pushPlayerHPChangeReason (lua_State *L, const PlayerHPChangeReason &reason)
Protected Member Functions inherited from LuaHelper
template<>
bool	readParam (lua_State *L, int index)
Static Protected Member Functions inherited from LuaHelper
static bool	isNaN (lua_State *L, int idx)
template<typename T >
static T	readParam (lua_State *L, int index)
	Read a value using a template type T from Lua State L and index. More...
template<typename T >
static T	readParam (lua_State *L, int index, const T &default_value)
	Read a value using a template type T from Lua State L and index. More...
Protected Attributes inherited from Thread
std::string	m_name
Protected Attributes inherited from ScriptApiBase
std::recursive_mutex	m_luastackmutex
std::string	m_last_run_mod
bool	m_secure = false
int	m_lock_recursion_count {}
std::thread::id	m_owning_thread

Constructor & Destructor Documentation

AsyncWorkerThread()

AsyncWorkerThread::AsyncWorkerThread	(	AsyncEngine *	jobDispatcher,
		const std::string &	name
	)

References Async, ScriptApiBase::getStack(), jobDispatcher, and AsyncEngine::prepareEnvironment().

Here is the call graph for this function:

~AsyncWorkerThread()

AsyncWorkerThread::~AsyncWorkerThread ( )

virtual

References Thread::isRunning(), and sanity_check.

Here is the call graph for this function:

Member Function Documentation

run()

void * AsyncWorkerThread::run ( )

virtual

Implements Thread.

References DIR_DELIM, errorstream, FATAL_ERROR, Server::getBuiltinLuaPath(), AsyncEngine::getJob(), ScriptApiBase::getServer(), ScriptApiBase::getStack(), jobDispatcher, ScriptApiBase::loadScript(), PCALL_RES, PUSH_ERROR_HANDLER, AsyncEngine::putJobResult(), LuaJobInfo::serializedFunction, LuaJobInfo::serializedParams, LuaJobInfo::serializedResult, Thread::stopRequested(), LuaJobInfo::valid, and BaseException::what().

Here is the call graph for this function:

Member Data Documentation

jobDispatcher

AsyncEngine* AsyncWorkerThread::jobDispatcher = nullptr

private

Referenced by AsyncWorkerThread(), and run().

---

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

• script/cpp_api/s_async.h
• script/cpp_api/s_async.cpp