RealityServer Web Services API Programmer's Manual

mi::rswservices::IServices_plugin Class Reference

[Extensions]

Description

The basic interface to be implemented by RealityServer Web Services plugins.

Public Member Functions

virtual const char* get_type() const
Returns the type of the plugin. More...
virtual void initialize( IExtension_context* context) =0
Initializes the plugin. More...
virtual void shutdown( IExtension_context* context) =0
Shutdowns the plugin. More...

Member Functions

virtual const char* mi::​rswservices::​IServices_plugin::get_type() const [inline, virtual]

Returns the type of the plugin. Do not reimplement or RealityServer Web Services will not be able to find the plugin.

virtual void mi::​rswservices::​IServices_plugin::initialize( IExtension_context* context) [pure virtual]

Initializes the plugin. This method should use context to install all user extensions implemented by the plugin. If required a plugin can retain context to enable it to install and remove extensions at a later time.

Parameters

context
the extension context.
virtual void mi::​rswservices::​IServices_plugin::shutdown( IExtension_context* context) [pure virtual]

Shutdowns the plugin. This method is called at shutdown to allow the plugin to perform any necessary clean up operations before shutdown. Note it is not required for the plugin to uninstall any installed extensions. If the plugin retained context during initialize it should release it here. Note that the context supplied will not be the same as the one provided durinig initialization.

Parameters

context
the extension context.