vdr 2.6.1
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 cOsdObjectMainMenuAction (void)
 
virtual cMenuSetupPageSetupMenu (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)
 
 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 cOsdObjectMainMenuAction (void)
 
virtual cMenuSetupPageSetupMenu (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)
 
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)
 
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 include/vdr/plugin.h.

Constructor & Destructor Documentation

◆ cPlugin() [1/2]

cPlugin::cPlugin ( void  )

Definition at line 32 of file plugin.c.

References name, and started.

◆ ~cPlugin() [1/2]

cPlugin::~cPlugin ( )
virtual

Definition at line 38 of file plugin.c.

◆ cPlugin() [2/2]

cPlugin::cPlugin ( void  )

◆ ~cPlugin() [2/2]

virtual cPlugin::~cPlugin ( )
virtual

Member Function Documentation

◆ Active() [1/2]

cString cPlugin::Active ( void  )
virtual

Definition at line 80 of file plugin.c.

Referenced by cPluginManager::Active().

◆ Active() [2/2]

virtual cString cPlugin::Active ( void  )
virtual

◆ CacheDirectory() [1/2]

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

Definition at line 154 of file plugin.c.

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

◆ CacheDirectory() [2/2]

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

◆ CommandLineHelp() [1/2]

const char * cPlugin::CommandLineHelp ( void  )
virtual

◆ CommandLineHelp() [2/2]

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

◆ ConfigDirectory() [1/2]

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

Definition at line 140 of file plugin.c.

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

◆ ConfigDirectory() [2/2]

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

◆ Description() [1/2]

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

◆ Description() [2/2]

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

◆ Housekeeping() [1/2]

void cPlugin::Housekeeping ( void  )
virtual

Reimplemented in cPluginHello, cPluginOsddemo, cPluginSkinCurses, and cPluginStatus.

Definition at line 72 of file plugin.c.

Referenced by cPluginManager::Housekeeping().

◆ Housekeeping() [2/2]

virtual void cPlugin::Housekeeping ( void  )
virtual

◆ Initialize() [1/2]

bool cPlugin::Initialize ( void  )
virtual

Reimplemented in cPluginEpgtableid0, and cPluginSkinCurses.

Definition at line 58 of file plugin.c.

Referenced by cPluginManager::InitializePlugins().

◆ Initialize() [2/2]

virtual bool cPlugin::Initialize ( void  )
virtual

Reimplemented in cPluginEpgtableid0, and cPluginSkinCurses.

◆ MainMenuAction() [1/2]

cOsdObject * cPlugin::MainMenuAction ( void  )
virtual

◆ MainMenuAction() [2/2]

virtual cOsdObject * cPlugin::MainMenuAction ( void  )
virtual

◆ MainMenuEntry() [1/2]

const char * cPlugin::MainMenuEntry ( void  )
virtual

◆ MainMenuEntry() [2/2]

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

◆ MainThreadHook() [1/2]

void cPlugin::MainThreadHook ( void  )
virtual

Reimplemented in cPluginDvbhddevice.

Definition at line 76 of file plugin.c.

Referenced by cPluginManager::MainThreadHook().

◆ MainThreadHook() [2/2]

virtual void cPlugin::MainThreadHook ( void  )
virtual

Reimplemented in cPluginDvbhddevice.

◆ Name() [1/2]

const char * cPlugin::Name ( void  )
inline

◆ Name() [2/2]

const char * cPlugin::Name ( void  )
inline

Definition at line 36 of file plugin.h.

References name.

◆ ProcessArgs() [1/2]

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

◆ ProcessArgs() [2/2]

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

◆ ResourceDirectory() [1/2]

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

◆ ResourceDirectory() [2/2]

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

◆ Service() [1/2]

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

◆ Service() [2/2]

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

Reimplemented in cPluginSvcCli, and cPluginSvcSvr.

◆ SetCacheDirectory() [1/2]

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

Definition at line 149 of file plugin.c.

References cacheDirectory.

Referenced by main().

◆ SetCacheDirectory() [2/2]

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

◆ SetConfigDirectory() [1/2]

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

Definition at line 135 of file plugin.c.

References configDirectory.

Referenced by main().

◆ SetConfigDirectory() [2/2]

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

◆ SetName() [1/2]

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

Definition at line 42 of file plugin.c.

References I18nRegister(), and name.

Referenced by cDll::Load().

◆ SetName() [2/2]

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

◆ SetResourceDirectory() [1/2]

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

Definition at line 163 of file plugin.c.

References resourceDirectory.

Referenced by main().

◆ SetResourceDirectory() [2/2]

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

◆ SetupMenu() [1/2]

cMenuSetupPage * cPlugin::SetupMenu ( void  )
virtual

◆ SetupMenu() [2/2]

virtual cMenuSetupPage * cPlugin::SetupMenu ( void  )
virtual

◆ SetupParse() [1/2]

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

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

Definition at line 105 of file plugin.c.

Referenced by cSetup::Load().

◆ SetupParse() [2/2]

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

◆ SetupStore() [1/4]

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

Definition at line 110 of file plugin.c.

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

Referenced by cMenuSetupPage::SetupStore().

◆ SetupStore() [2/4]

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

◆ SetupStore() [3/4]

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

Definition at line 115 of file plugin.c.

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

◆ SetupStore() [4/4]

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

◆ Start() [1/2]

bool cPlugin::Start ( void  )
virtual

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

Definition at line 63 of file plugin.c.

Referenced by cPluginManager::StartPlugins().

◆ Start() [2/2]

virtual bool cPlugin::Start ( void  )
virtual

◆ Stop() [1/2]

void cPlugin::Stop ( void  )
virtual

Reimplemented in cPluginDvbhddevice.

Definition at line 68 of file plugin.c.

Referenced by cPluginManager::StopPlugins().

◆ Stop() [2/2]

virtual void cPlugin::Stop ( void  )
virtual

Reimplemented in cPluginDvbhddevice.

◆ SVDRPCommand() [1/2]

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

Reimplemented in cPluginSvdrpdemo.

Definition at line 130 of file plugin.c.

Referenced by cSVDRPServer::CmdPLUG().

◆ SVDRPCommand() [2/2]

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

Reimplemented in cPluginSvdrpdemo.

◆ SVDRPHelpPages() [1/2]

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

Reimplemented in cPluginSvdrpdemo.

Definition at line 125 of file plugin.c.

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

◆ SVDRPHelpPages() [2/2]

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

Reimplemented in cPluginSvdrpdemo.

◆ Version() [1/2]

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

◆ Version() [2/2]

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

◆ WakeupTime() [1/2]

time_t cPlugin::WakeupTime ( void  )
virtual

◆ WakeupTime() [2/2]

virtual time_t cPlugin::WakeupTime ( void  )
virtual

Friends And Related Function Documentation

◆ cDll

cDll
friend

Definition at line 23 of file include/vdr/plugin.h.

◆ cPluginManager

Definition at line 24 of file include/vdr/plugin.h.

Member Data Documentation

◆ cacheDirectory

static cString cPlugin::cacheDirectory
staticprivate

Definition at line 27 of file include/vdr/plugin.h.

Referenced by CacheDirectory(), and SetCacheDirectory().

◆ configDirectory

static cString cPlugin::configDirectory
staticprivate

Definition at line 26 of file include/vdr/plugin.h.

Referenced by ConfigDirectory(), and SetConfigDirectory().

◆ name

const char * cPlugin::name
private

Definition at line 29 of file include/vdr/plugin.h.

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

◆ resourceDirectory

static cString cPlugin::resourceDirectory
staticprivate

Definition at line 28 of file include/vdr/plugin.h.

Referenced by ResourceDirectory(), and SetResourceDirectory().

◆ started

bool cPlugin::started
private

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