Kodi Documentation  20.0
Kodi is an open source media player and entertainment hub.
XBMCAddon::Callback Class Referenceabstract

#include <CallbackFunction.h>

Inheritance diagram for XBMCAddon::Callback:
Collaboration diagram for XBMCAddon::Callback:

Public Member Functions

virtual void executeCallback ()=0
 
 ~Callback () override
 
AddonClassgetObject ()
 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 

Protected Member Functions

 Callback (AddonClass *_object)
 
- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 

Protected Attributes

AddonClassaddonClassObject
 
- Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHooklanguageHook
 
- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

Additional Inherited Members

- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 
- Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short getNextClassIndex ()
 

Detailed Description

This is the parent class for the class templates that hold a callback. A callback is essentially a templatized functor (functoid?) for a call to a member function.

This class combined with the attending CallbackHandlers should make sure that the AddonClass isn't in the midst of deallocating when the callback executes. In this way the Callback class acts as a weak reference.

Constructor & Destructor Documentation

◆ Callback()

XBMCAddon::Callback::Callback ( AddonClass _object)
inlineexplicitprotected

◆ ~Callback()

XBMCAddon::Callback::~Callback ( )
override

Member Function Documentation

◆ executeCallback()

◆ getObject()

AddonClass* XBMCAddon::Callback::getObject ( )
inline

Member Data Documentation

◆ addonClassObject

AddonClass* XBMCAddon::Callback::addonClassObject
protected

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