PDI 0.4.1

Data exchange made easy

PDI::Plugin Class Reference

Public Member Functions

 Plugin (const Plugin &)=delete
 
 Plugin (Plugin &&)=delete
 
 Plugin (Context &ctx)
 Initialization of the plugin. More...
 
virtual ~Plugin () noexcept(false)
 
virtual void event (const char *event)
 Notification for a named event. More...
 
virtual void empty_desc_access (const char *name)
 Notification for accessing empty desc by user. More...
 
virtual void data (const char *name, Ref ref)
 Notification that some data becomes available. More...
 
Contextcontext ()
 Provides access to the PDI context for this plugin instance. More...
 

Constructor & Destructor Documentation

◆ Plugin() [1/3]

PDI::Plugin::Plugin ( const Plugin )
delete

◆ Plugin() [2/3]

PDI::Plugin::Plugin ( Plugin &&  )
delete

◆ Plugin() [3/3]

PDI::Plugin::Plugin ( Context ctx)

Initialization of the plugin.

Parameters
ctxthe PDI context for this plugin instance

◆ ~Plugin()

virtual PDI::Plugin::~Plugin ( )
virtualnoexcept

Member Function Documentation

◆ event()

virtual void PDI::Plugin::event ( const char *  event)
virtual

Notification for a named event.

Parameters
[in]eventthe event name

◆ empty_desc_access()

virtual void PDI::Plugin::empty_desc_access ( const char *  name)
virtual

Notification for accessing empty desc by user.

Parameters
[in]namethe name of accessing desc

◆ data()

virtual void PDI::Plugin::data ( const char *  name,
Ref  ref 
)
virtual

Notification that some data becomes available.

Parameters
namethe name of the data made available
refa reference to the data value

◆ context()

Context& PDI::Plugin::context ( )

Provides access to the PDI context for this plugin instance.


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