info.pppc.base.system.plugin

Interface IPlugin

All Superinterfaces:

IExtension

All Known Subinterfaces:

IDiscovery, IIPPlugin, IModifier, IMultiplexPlugin, IRouting, ISemantic, ITransceiver

All Known Implementing Classes:

ExchangeSemantic, IPBroadcastTransceiver, IPMulticastTransceiver, MxIPBroadcastTransceiver, MxIPMulticastTransceiver, MxIPProactiveRouting, ObjectSerializer, ProactiveDiscovery, ProactiveRouting, RmiSemantic, SecureModifier, ServerHandshakeSemantic, StreamSemantic, TimedDiscovery

public interface IPlugin
extends IExtension

This is the base interface that must be implemented by all plug-in implementations. All plug-ins must be able to provide a plug-in descriptions and they must support the start and stop callbacks that are issued by the plug-in manager upon installation and removal of the plug-in.

Author:

Marcus Handte

Field Summary

Fields inherited from interface info.pppc.base.system.IExtension

EXTENSION_COMPRESSION, EXTENSION_DISCOVERY, EXTENSION_ENCRYPTION, EXTENSION_ROUTING, EXTENSION_SEMANTIC, EXTENSION_SERIALIZATION, EXTENSION_TRANSCEIVER

Method Summary

Methods

Modifier and Type	Method and Description
PluginDescription	getPluginDescription() Returns the plug-in description of the plug-in.
void	start() Called by the plug-in manager whenever the plug-in is installed.
void	stop() Called by the plug-in manager whenever the plug-in is removed.

Method Detail

start

void start()

Called by the plug-in manager whenever the plug-in is installed. This call signals that the plug-in should start processing. Note that a call to this method does not mean that a transceiver plug-in should open a communication end point as the set enabled method of the transceiver interface is used to signal that.

stop

void stop()

Called by the plug-in manager whenever the plug-in is removed. This call signals that the plug-in should refrain from performing any further computation and it should release all resources that it has acquired during the execution.

getPluginDescription

PluginDescription getPluginDescription()

Returns the plug-in description of the plug-in. The plug-in description contains the plug-in specific parameters that need to be announced in order to communicate with the plug-in. Furthermore, it describes the ability of the plug-in and its extensions.

Returns:

The plug-in description.