Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CRunningScriptsHandler< TScript > Class Template Reference

#include <RunningScriptsHandler.h>

Inheritance diagram for CRunningScriptsHandler< TScript >:
CScriptRunner

Protected Types

using HandleType = int
 

Protected Member Functions

 CRunningScriptsHandler ()=default
 
virtual ~CRunningScriptsHandler ()=default
 
bool RunScript (TScript *script, const ADDON::AddonPtr &addon, const std::string &path, bool resume)
 
ADDON::AddonPtr GetAddon () const
 
void SetDone ()
 
bool StartScript (const ADDON::AddonPtr &addon, const std::string &path)
 
- Protected Member Functions inherited from CScriptRunner
 CScriptRunner ()
 
virtual ~CScriptRunner ()=default
 
virtual bool IsSuccessful () const =0
 
virtual bool IsCancelled () const =0
 
ADDON::AddonPtr GetAddon () const
 
bool StartScript (const ADDON::AddonPtr &addon, const std::string &path)
 
bool RunScript (const ADDON::AddonPtr &addon, const std::string &path, int handle, bool resume)
 
void SetDone ()
 

Static Protected Member Functions

static HandleType GetNewScriptHandle (TScript *script)
 
static void ReuseScriptHandle (HandleType handle, TScript *script)
 
static void RemoveScriptHandle (HandleType handle)
 
static TScript * GetScriptFromHandle (HandleType handle)
 
static CCriticalSection & GetScriptsLock ()
 
static int ExecuteScript (const ADDON::AddonPtr &addon, const std::string &path, bool resume)
 
static int ExecuteScript (const ADDON::AddonPtr &addon, const std::string &path, int handle, bool resume)
 
- Static Protected Member Functions inherited from CScriptRunner
static int ExecuteScript (const ADDON::AddonPtr &addon, const std::string &path, bool resume)
 
static int ExecuteScript (const ADDON::AddonPtr &addon, const std::string &path, int handle, bool resume)
 

Member Typedef Documentation

◆ HandleType

template<class TScript >
using CRunningScriptsHandler< TScript >::HandleType = int
protected

Constructor & Destructor Documentation

◆ CRunningScriptsHandler()

template<class TScript >
CRunningScriptsHandler< TScript >::CRunningScriptsHandler ( )
protecteddefault

◆ ~CRunningScriptsHandler()

template<class TScript >
virtual CRunningScriptsHandler< TScript >::~CRunningScriptsHandler ( )
protectedvirtualdefault

Member Function Documentation

◆ ExecuteScript() [1/2]

template<class TScript >
int CScriptRunner::ExecuteScript ( const ADDON::AddonPtr & addon,
const std::string & path,
bool resume )
staticprotected

◆ ExecuteScript() [2/2]

template<class TScript >
int CScriptRunner::ExecuteScript ( const ADDON::AddonPtr & addon,
const std::string & path,
int handle,
bool resume )
staticprotected

◆ GetAddon()

template<class TScript >
ADDON::AddonPtr CScriptRunner::GetAddon ( ) const
protected

◆ GetNewScriptHandle()

template<class TScript >
static HandleType CRunningScriptsHandler< TScript >::GetNewScriptHandle ( TScript * script)
inlinestaticprotected

◆ GetScriptFromHandle()

template<class TScript >
static TScript * CRunningScriptsHandler< TScript >::GetScriptFromHandle ( HandleType handle)
inlinestaticprotected

◆ GetScriptsLock()

template<class TScript >
static CCriticalSection & CRunningScriptsHandler< TScript >::GetScriptsLock ( )
inlinestaticprotected

◆ RemoveScriptHandle()

template<class TScript >
static void CRunningScriptsHandler< TScript >::RemoveScriptHandle ( HandleType handle)
inlinestaticprotected

◆ ReuseScriptHandle()

template<class TScript >
static void CRunningScriptsHandler< TScript >::ReuseScriptHandle ( HandleType handle,
TScript * script )
inlinestaticprotected

◆ RunScript()

template<class TScript >
bool CRunningScriptsHandler< TScript >::RunScript ( TScript * script,
const ADDON::AddonPtr & addon,
const std::string & path,
bool resume )
inlineprotected

◆ SetDone()

template<class TScript >
void CScriptRunner::SetDone ( )
protected

◆ StartScript()

template<class TScript >
bool CScriptRunner::StartScript ( const ADDON::AddonPtr & addon,
const std::string & path )
protected

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