Main Page | Packages | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members

sspPlugin.SyncPluginInterface Interface Reference

import "sspPlugin.idl";

Inheritance diagram for sspPlugin.SyncPluginInterface:

sspPlugin.PluginInterface sspPlugin.StateSyncPlugin List of all members.

Detailed Description

Stateful plug-in interface; extension of the basic plug-in interface.

The stateful plug-in interface is used for plug-ins that need to keep track of the state across reboots of the SAE. Stateful plug-ins are called when synchronization between the router and the SAE begins and ends. It also receives all tracking events related to the termination of a subscriber or a service, and it is notified when the SAE is preparing to stop. This notification is not guaranteed to be sent every time the SAE stops, as in the event of a crash.


Public Member Functions

void restart (in string pepId)
 The restart() method is called when the connection between a router and the SAE is established and their synchronization is about to begin.

void restartComplete (in string pepId, in boolean isPepReset) raises (OutOfSync)
 The restartComplete() method is called when the synchronization between a router and the SAE is completed.

void stop (in string pepId)
 The stop() method is called when the connection between a router and the SAE is terminated.


Member Function Documentation

void sspPlugin.SyncPluginInterface.restart in string  pepId  ) 
 

The restart() method is called when the connection between a router and the SAE is established and their synchronization is about to begin.

Parameters:
[in] pepId Identification of the router that is connected to the SAE

void sspPlugin.SyncPluginInterface.restartComplete in string  pepId,
in boolean  isPepReset
raises (OutOfSync)
 

The restartComplete() method is called when the synchronization between a router and the SAE is completed.

Parameters:
[in] pepId Identification of the router that is connected to the SAE
[in] isPepReset Flag that specifies whether the router is starting as if it were reset; that is, no active users or services are present
Exceptions:
OutOfSync Raised if the plug-in is out of sync

void sspPlugin.SyncPluginInterface.stop in string  pepId  ) 
 

The stop() method is called when the connection between a router and the SAE is terminated.

The plug-in cannot rely on this message being delivered every time the server is stopped.

Parameters:
[in] pepId Identification of the router that is connected to the SAE


The documentation for this interface was generated from the following file:
Generated on Tue Jun 15 10:17:16 2010 for SAE CORBA Plug-In Service Provider Interface (SPI) by doxygen 1.3.7