vdr 2.8.3
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
cPlugin Class Referenceabstract

#include <plugin.h>

Public Member Functions

 cPlugin (void)
virtual ~cPlugin ()
const char * Name (void)
virtual const char * Version (void)=0
virtual const char * Description (void)=0
virtual const char * CommandLineHelp (void)
virtual bool ProcessArgs (int argc, char *argv[])
virtual bool Initialize (void)
virtual bool Start (void)
virtual void Stop (void)
virtual void Housekeeping (void)
virtual void MainThreadHook (void)
virtual cString Active (void)
virtual time_t WakeupTime (void)
virtual const char * MainMenuEntry (void)
virtual cOsdObject * MainMenuAction (void)
virtual cMenuSetupPage * SetupMenu (void)
virtual bool SetupParse (const char *Name, const char *Value)
void SetupStore (const char *Name, const char *Value=NULL)
void SetupStore (const char *Name, int Value)
virtual bool Service (const char *Id, void *Data=NULL)
virtual const char ** SVDRPHelpPages (void)
virtual cString SVDRPCommand (const char *Command, const char *Option, int &ReplyCode)

Static Public Member Functions

static void SetConfigDirectory (const char *Dir)
static const char * ConfigDirectory (const char *PluginName=NULL)
static void SetCacheDirectory (const char *Dir)
static const char * CacheDirectory (const char *PluginName=NULL)
static void SetResourceDirectory (const char *Dir)
static const char * ResourceDirectory (const char *PluginName=NULL)

Private Member Functions

void SetName (const char *s)

Private Attributes

const char * name
bool started

Static Private Attributes

static cString configDirectory
static cString cacheDirectory
static cString resourceDirectory

Friends

class cDll
class cPluginManager

Detailed Description

Definition at line 22 of file plugin.h.

Constructor & Destructor Documentation

◆ cPlugin()

cPlugin::cPlugin ( void )

Definition at line 33 of file plugin.c.

References name, and started.

Referenced by cPluginSvcCli::MainMenuAction().

◆ ~cPlugin()

cPlugin::~cPlugin ( )
virtual

Definition at line 39 of file plugin.c.

Member Function Documentation

◆ Active()

cString cPlugin::Active ( void )
virtual

Definition at line 81 of file plugin.c.

Referenced by cPluginManager::Active(), and Description().

◆ CacheDirectory()

const char * cPlugin::CacheDirectory ( const char * PluginName = NULL)
static

Definition at line 155 of file plugin.c.

References cacheDirectory, esyslog, cThread::IsMainThread(), MakeDirs(), and cString::sprintf().

Referenced by Description().

◆ CommandLineHelp()

const char * cPlugin::CommandLineHelp ( void )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginPictures, cPluginSkinCurses, and cPluginStatus.

Definition at line 49 of file plugin.c.

Referenced by Description(), and main().

◆ ConfigDirectory()

const char * cPlugin::ConfigDirectory ( const char * PluginName = NULL)
static

Definition at line 141 of file plugin.c.

References configDirectory, esyslog, cThread::IsMainThread(), MakeDirs(), and cString::sprintf().

Referenced by Description().

◆ Description()

virtual const char * cPlugin::Description ( void )
pure virtual

Implemented in cPluginEpgtableid0, cPluginHello, cPluginOsddemo, cPluginPictures, cPluginSkinCurses, cPluginStatus, cPluginSvcCli, cPluginSvcSvr, and cPluginSvdrpdemo.

References Active(), CacheDirectory(), CommandLineHelp(), ConfigDirectory(), Housekeeping(), Initialize(), MainMenuAction(), MainMenuEntry(), MainThreadHook(), Name(), ProcessArgs(), ResourceDirectory(), Service(), SetCacheDirectory(), SetConfigDirectory(), SetResourceDirectory(), SetupMenu(), SetupParse(), SetupStore(), Start(), Stop(), SVDRPCommand(), SVDRPHelpPages(), and WakeupTime().

Referenced by cSVDRPServer::CmdHELP(), cSVDRPServer::CmdPLUG(), cMenuSetupPlugins::cMenuSetupPlugins(), cPluginManager::InitializePlugins(), and main().

◆ Housekeeping()

void cPlugin::Housekeeping ( void )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginSkinCurses, and cPluginStatus.

Definition at line 73 of file plugin.c.

Referenced by Description(), and cPluginManager::Housekeeping().

◆ Initialize()

bool cPlugin::Initialize ( void )
virtual

Reimplemented in cPluginEpgtableid0, and cPluginSkinCurses.

Definition at line 59 of file plugin.c.

Referenced by Description(), and cPluginManager::InitializePlugins().

◆ MainMenuAction()

cOsdObject * cPlugin::MainMenuAction ( void )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginPictures, cPluginSkinCurses, cPluginStatus, and cPluginSvcCli.

Definition at line 96 of file plugin.c.

Referenced by Description(), main(), and cMenuMain::ProcessKey().

◆ MainMenuEntry()

const char * cPlugin::MainMenuEntry ( void )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginPictures, cPluginSkinCurses, cPluginStatus, and cPluginSvcCli.

Definition at line 91 of file plugin.c.

Referenced by Description(), and cMenuMain::Set().

◆ MainThreadHook()

void cPlugin::MainThreadHook ( void )
virtual
Deprecated
use proper locking instead

Definition at line 77 of file plugin.c.

Referenced by Description(), and cPluginManager::MainThreadHook().

◆ Name()

const char * cPlugin::Name ( void )
inline

Definition at line 36 of file plugin.h.

References name.

Referenced by cSVDRPServer::CmdHELP(), cSVDRPServer::CmdPLUG(), cMenuSetupPlugins::cMenuSetupPlugins(), cShutdownHandler::ConfirmShutdown(), Description(), cShutdownHandler::DoShutdown(), cPluginManager::GetPlugin(), cPluginManager::InitializePlugins(), main(), cPluginSvcCli::MainMenuAction(), cPluginSvcCli::Service(), cPluginSvcSvr::Service(), cMenuSetupPage::SetPlugin(), SetupParse(), cPluginHello::SetupParse(), cPluginOsddemo::SetupParse(), cPluginPictures::SetupParse(), cPluginSkinCurses::SetupParse(), cPluginStatus::SetupParse(), SetupStore(), SetupStore(), cPluginManager::Shutdown(), cPluginManager::StartPlugins(), and cPluginManager::StopPlugins().

◆ ProcessArgs()

bool cPlugin::ProcessArgs ( int argc,
char * argv[] )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginPictures, cPluginSkinCurses, and cPluginStatus.

Definition at line 54 of file plugin.c.

Referenced by Description(), and cDll::Load().

◆ ResourceDirectory()

const char * cPlugin::ResourceDirectory ( const char * PluginName = NULL)
static

Definition at line 169 of file plugin.c.

References esyslog, cThread::IsMainThread(), MakeDirs(), resourceDirectory, and cString::sprintf().

Referenced by Description().

◆ Service()

bool cPlugin::Service ( const char * Id,
void * Data = NULL )
virtual

Reimplemented in cPluginSvcCli, and cPluginSvcSvr.

Definition at line 121 of file plugin.c.

Referenced by cPluginManager::CallAllServices(), cPluginManager::CallFirstService(), Description(), and cPluginSvcCli::MainMenuAction().

◆ SetCacheDirectory()

void cPlugin::SetCacheDirectory ( const char * Dir)
static

Definition at line 150 of file plugin.c.

References cacheDirectory.

Referenced by Description(), and main().

◆ SetConfigDirectory()

void cPlugin::SetConfigDirectory ( const char * Dir)
static

Definition at line 136 of file plugin.c.

References configDirectory.

Referenced by Description(), and main().

◆ SetName()

void cPlugin::SetName ( const char * s)
private

Definition at line 43 of file plugin.c.

References I18nRegister(), and name.

Referenced by cDll::Load().

◆ SetResourceDirectory()

void cPlugin::SetResourceDirectory ( const char * Dir)
static

Definition at line 164 of file plugin.c.

References resourceDirectory.

Referenced by Description(), and main().

◆ SetupMenu()

cMenuSetupPage * cPlugin::SetupMenu ( void )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginPictures, cPluginSkinCurses, and cPluginStatus.

Definition at line 101 of file plugin.c.

Referenced by Description(), and cMenuSetupPlugins::ProcessKey().

◆ SetupParse()

bool cPlugin::SetupParse ( const char * Name,
const char * Value )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginPictures, cPluginSkinCurses, and cPluginStatus.

Definition at line 106 of file plugin.c.

References Name().

Referenced by Description(), and cSetup::Load().

◆ SetupStore() [1/2]

void cPlugin::SetupStore ( const char * Name,
const char * Value = NULL )

Definition at line 111 of file plugin.c.

References Name(), Setup, and cSetup::Store().

Referenced by Description(), cMenuSetupPage::SetupStore(), and cMenuSetupPage::SetupStore().

◆ SetupStore() [2/2]

void cPlugin::SetupStore ( const char * Name,
int Value )

Definition at line 116 of file plugin.c.

References Name(), Setup, and cSetup::Store().

◆ Start()

bool cPlugin::Start ( void )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginSkinCurses, and cPluginStatus.

Definition at line 64 of file plugin.c.

Referenced by Description(), and cPluginManager::StartPlugins().

◆ Stop()

void cPlugin::Stop ( void )
virtual

Definition at line 69 of file plugin.c.

Referenced by Description(), and cPluginManager::StopPlugins().

◆ SVDRPCommand()

cString cPlugin::SVDRPCommand ( const char * Command,
const char * Option,
int & ReplyCode )
virtual

Reimplemented in cPluginSvdrpdemo.

Definition at line 131 of file plugin.c.

Referenced by cSVDRPServer::CmdPLUG(), and Description().

◆ SVDRPHelpPages()

const char ** cPlugin::SVDRPHelpPages ( void )
virtual

Reimplemented in cPluginSvdrpdemo.

Definition at line 126 of file plugin.c.

Referenced by cSVDRPServer::CmdHELP(), cSVDRPServer::CmdPLUG(), and Description().

◆ Version()

virtual const char * cPlugin::Version ( void )
pure virtual

Implemented in cPluginEpgtableid0, cPluginHello, cPluginOsddemo, cPluginPictures, cPluginSkinCurses, cPluginStatus, cPluginSvcCli, cPluginSvcSvr, and cPluginSvdrpdemo.

Referenced by cSVDRPServer::CmdHELP(), cSVDRPServer::CmdPLUG(), cMenuSetupPlugins::cMenuSetupPlugins(), cPluginManager::InitializePlugins(), and main().

◆ WakeupTime()

time_t cPlugin::WakeupTime ( void )
virtual

Definition at line 86 of file plugin.c.

Referenced by cShutdownHandler::ConfirmShutdown(), Description(), cShutdownHandler::DoShutdown(), and cPluginManager::GetNextWakeupPlugin().

◆ cDll

friend class cDll
friend

Definition at line 23 of file plugin.h.

References cDll.

Referenced by cDll.

◆ cPluginManager

friend class cPluginManager
friend

Definition at line 24 of file plugin.h.

References cPluginManager.

Referenced by cPluginManager.

Member Data Documentation

◆ cacheDirectory

cString cPlugin::cacheDirectory
staticprivate

Definition at line 27 of file plugin.h.

Referenced by CacheDirectory(), and SetCacheDirectory().

◆ configDirectory

cString cPlugin::configDirectory
staticprivate

Definition at line 26 of file plugin.h.

Referenced by ConfigDirectory(), and SetConfigDirectory().

◆ name

const char* cPlugin::name
private

Definition at line 29 of file plugin.h.

Referenced by cPlugin(), Name(), and SetName().

◆ resourceDirectory

cString cPlugin::resourceDirectory
staticprivate

Definition at line 28 of file plugin.h.

Referenced by ResourceDirectory(), and SetResourceDirectory().

◆ started

bool cPlugin::started
private

Definition at line 30 of file plugin.h.

Referenced by cPlugin(), cPluginManager::StartPlugins(), and cPluginManager::StopPlugins().

The documentation for this class was generated from the following files:
Generated by doxygen 1.18.0