sspPlugin.StateSyncPlugin Interface Reference

State synchronization plug-in interface; extension of the stateful plug-in interface. More...

import "sspPlugin.idl";

Inheritance diagram for sspPlugin.StateSyncPlugin:
sspPlugin.SyncPluginInterface sspPlugin.PluginInterface

List of all members.

Classes

struct  PluginEvent
 Data structure for encapsulating a single plug-in event for bulk synchronization. More...

Public Types

typedef sequence< string > StringSeq
 Attributes are passed to the readyToSync() method as a sequence of strings.
typedef sequence< PluginEventPluginEventSeq
 Sequence of plug-in events passed to the trackBulk() method during bulk synchronization.

Public Member Functions

long readyToSync (in StringSeq pepIds, in boolean queueValid)
 The readyToSync() method verifies whether the plug-in is ready to receive state synchronization.
void trackBulk (in PluginEventSeq events) raises (OutOfSync)
 The trackBulk() method is called to synchronize a set of events.
void syncComplete (in StringSeq pepIds)
 The syncComplete() method is called to signal the end of synchronization.
void ping (in StringSeq pepIds) raises (OutOfSync)
 The ping() method verifies whether the plug-in is still ready to respond to events.

Detailed Description

State synchronization plug-in interface; extension of the stateful plug-in interface.

The state synchronization plug-in interface allows external plug-ins to maintain the state of active sessions without having to store intermediate versions of the state locally. If the state is not synchronized, the SAE replays the current state to the plug-in. Plug-ins implementing this interface can synchronize the current state at startup.

During synchronization, start events may be sent twice. A plug-in implementing this interface must discard the duplicates.


Member Typedef Documentation

Sequence of plug-in events passed to the trackBulk() method during bulk synchronization.

typedef sequence<string> sspPlugin.StateSyncPlugin.StringSeq

Attributes are passed to the readyToSync() method as a sequence of strings.

  • The pepIds parameter identifies the router currently managed by the SAE.
  • The queueValid parameter indicates whether the SAE has a valid buffer of events.

Member Function Documentation

void sspPlugin.StateSyncPlugin.ping ( in StringSeq  pepIds  )  raises (OutOfSync)

The ping() method verifies whether the plug-in is still ready to respond to events.

Exceptions:
OutOfSync Raised if the plug-in is up, but out of sync.
Parameters:
[in] pepIds Identification of routers that are currently managed by SAE
long sspPlugin.StateSyncPlugin.readyToSync ( in StringSeq  pepIds,
in boolean  queueValid 
)

The readyToSync() method verifies whether the plug-in is ready to receive state synchronization.

Parameters:
pepIds Identification of routers that are currently managed by SAE
queueValid Flag that specifies whether the SAE has buffered all events since the plug-in became unreachable (true); if set to false, the plug-in must perform full synchronization.
Returns:
-1 Not ready to synchronize
0 Ready, but no synchronization required
1 Send synchronization using track()
>1 Maximum number of events accepted using trackBulk()
void sspPlugin.StateSyncPlugin.syncComplete ( in StringSeq  pepIds  ) 

The syncComplete() method is called to signal the end of synchronization.

Up to this message, start events may be duplicated. After this message is sent, no duplicate events are sent.

Parameters:
[in] pepIds Identification of routers that have finished synchronization
void sspPlugin.StateSyncPlugin.trackBulk ( in PluginEventSeq  events  )  raises (OutOfSync)

The trackBulk() method is called to synchronize a set of events.

Exceptions:
OutOfSync Raised if the plug-in is out of sync

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

Generated on 23 Dec 2014 for SAE CORBA Plug-In Service Provider Interface (SPI) by  doxygen 1.6.1