Ice::PluginManager Local Interface Reference

Each communicator has a plug-in manager to administer the set of plug-ins. More...

defined in <Ice/Plugin.ice>

local interface PluginManager { ... }

Operations
void	addPlugin (string name, Plugin pi)
	Install a new plug-in. More...
void	destroy ()
	Called when the communicator is being destroyed. More...
Plugin	getPlugin (string name)
	Obtain a plug-in by name. More...
StringSeq	getPlugins ()
	Get a list of plugins installed. More...
void	initializePlugins ()
	Initialize the configured plug-ins. More...

Detailed Description

Each communicator has a plug-in manager to administer the set of plug-ins.

Operation Documentation

addPlugin()

void addPlugin	(	string	name,
		Plugin	pi
	)

Install a new plug-in.

Parameters

name	The plug-in's name.
pi	The plug-in.

Exceptions

AlreadyRegisteredException

Raised if a plug-in already exists with the given name.

destroy()

["cpp:noexcept","swift:noexcept"]

void destroy

(

)

Called when the communicator is being destroyed.

getPlugin()

Plugin getPlugin

(

string

name

)

Obtain a plug-in by name.

Parameters

name	The plug-in's name.

Returns

The plug-in.

Exceptions

NotRegisteredException

Raised if no plug-in is found with the given name.

getPlugins()

["cpp:noexcept","swift:noexcept"]

StringSeq getPlugins

(

)

Get a list of plugins installed.

Returns

The names of the plugins installed.

See also

getPlugin

initializePlugins()

void initializePlugins

(

)

Initialize the configured plug-ins.

The communicator automatically initializes the plug-ins by default, but an application may need to interact directly with a plug-in prior to initialization. In this case, the application must set Ice.InitPlugins=0 and then invoke initializePlugins manually. The plug-ins are initialized in the order in which they are loaded. If a plug-in raises an exception during initialization, the communicator invokes destroy on the plug-ins that have already been initialized.

Exceptions

InitializationException

Raised if the plug-ins have already been initialized.

---

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

• Ice/Plugin.ice