Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ILanguageInvoker Class Referenceabstract

#include <ILanguageInvoker.h>

Inheritance diagram for ILanguageInvoker:
CLanguageInvokerThread CPythonInvoker CAddonPythonInvoker CHTTPPythonInvoker CContextItemAddonInvoker CHTTPPythonWsgiInvoker

Public Member Functions

 ILanguageInvoker (ILanguageInvocationHandler *invocationHandler)
 
virtual ~ILanguageInvoker ()
 
virtual bool Execute (const std::string &script, const std::vector< std::string > &arguments=std::vector< std::string >())
 
virtual bool Stop (bool abort=false)
 
virtual bool IsStopping () const
 
void SetId (int id)
 
int GetId () const
 
const ADDON::AddonPtr & GetAddon () const
 
void SetAddon (const ADDON::AddonPtr &addon)
 
InvokerState GetState () const
 
bool IsActive () const
 
bool IsRunning () const
 
void Reset ()
 

Protected Member Functions

virtual bool execute (const std::string &script, const std::vector< std::string > &arguments)=0
 
virtual bool stop (bool abort)=0
 
virtual void pulseGlobalEvent ()
 
virtual bool onExecutionInitialized ()
 
virtual void onAbortRequested ()
 
virtual void onExecutionFailed ()
 
virtual void onExecutionDone ()
 
virtual void onExecutionFinalized ()
 
void setState (InvokerState state)
 

Protected Attributes

ADDON::AddonPtr m_addon
 

Friends

class CLanguageInvokerThread
 

Constructor & Destructor Documentation

§ ILanguageInvoker()

ILanguageInvoker::ILanguageInvoker ( ILanguageInvocationHandler *  invocationHandler)
explicit

§ ~ILanguageInvoker()

ILanguageInvoker::~ILanguageInvoker ( )
virtualdefault

Member Function Documentation

§ Execute()

bool ILanguageInvoker::Execute ( const std::string &  script,
const std::vector< std::string > &  arguments = std::vector<std::string>() 
)
virtual

Reimplemented in CPythonInvoker.

§ execute()

virtual bool ILanguageInvoker::execute ( const std::string &  script,
const std::vector< std::string > &  arguments 
)
protectedpure virtual

Implemented in CPythonInvoker, and CLanguageInvokerThread.

§ GetAddon()

const ADDON::AddonPtr& ILanguageInvoker::GetAddon ( ) const
inline

§ GetId()

int ILanguageInvoker::GetId ( ) const
inline

§ GetState()

InvokerState ILanguageInvoker::GetState ( ) const
inline

§ IsActive()

bool ILanguageInvoker::IsActive ( ) const

§ IsRunning()

bool ILanguageInvoker::IsRunning ( ) const

§ IsStopping()

bool ILanguageInvoker::IsStopping ( ) const
virtual

Reimplemented in CPythonInvoker.

§ onAbortRequested()

void ILanguageInvoker::onAbortRequested ( )
protectedvirtual

§ onExecutionDone()

void ILanguageInvoker::onExecutionDone ( )
protectedvirtual

Reimplemented in CPythonInvoker.

§ onExecutionFailed()

void ILanguageInvoker::onExecutionFailed ( )
protectedvirtual

Reimplemented in CPythonInvoker.

§ onExecutionFinalized()

void ILanguageInvoker::onExecutionFinalized ( )
protectedvirtual

§ onExecutionInitialized()

bool ILanguageInvoker::onExecutionInitialized ( )
protectedvirtual

§ pulseGlobalEvent()

void ILanguageInvoker::pulseGlobalEvent ( )
protectedvirtual

§ Reset()

void ILanguageInvoker::Reset ( void  )
inline

§ SetAddon()

void ILanguageInvoker::SetAddon ( const ADDON::AddonPtr &  addon)
inline

§ SetId()

void ILanguageInvoker::SetId ( int  id)
inline

§ setState()

void ILanguageInvoker::setState ( InvokerState  state)
protected

§ Stop()

bool ILanguageInvoker::Stop ( bool  abort = false)
virtual

§ stop()

virtual bool ILanguageInvoker::stop ( bool  abort)
protectedpure virtual

Implemented in CPythonInvoker, and CLanguageInvokerThread.

Friends And Related Function Documentation

§ CLanguageInvokerThread

friend class CLanguageInvokerThread
friend

Member Data Documentation

§ m_addon

ADDON::AddonPtr ILanguageInvoker::m_addon
protected
The documentation for this class was generated from the following files: