nn::nex::IDGenerator Class

Syntax

class IDGenerator : private nn::nex::DuplicatedObject

Description

Generates a unique ID for each entity.

This class is used to create a unique ID for each entity in an application. IDs are generated by an instance of this class. Although the ID is guaranteed to be unique, there is a chance that the same ID might be generated by multiple IDGenerator class instances.

This class is used by the system to automatically set Duplication Object IDs. However, when using this class to generate duplication object IDs, this class must be created for each duplicated object class. (This is due to the need to assign a unique ID to each separate class.)

All IDGenerator objects are global. Discovery is guaranteed for a station to join a session.

Member Functions

GenerateID Generates a usable, unique ID that can be used from the IDGenerator through all stations.
SetIDRange Sets the range of IDs that can be generated by this IDGenerator.
SetRequestedRangeSize Sets the range of IDs that can be requested of a duplication master by a duplica.
GetRequestedRangeSize Gets the range of IDs that can be requested of a duplication master by a duplica.
V ApproveEmigration Returns whether the duplicated object migrates.
V ApproveFaultRecovery Returns whether to use fault recovery for duplicated objects.
V OperationEnd Called every time a duplicated object system operation ends.
V Trace Traces information related to the current ID range duplication master and this local station.
GetNbLocalIDs Gets the number of usable IDs that exist in the local pool.
S SetDefaultRequestedRangeSize Sets the default values for the range of IDs that duplicas can request on the duplication master when IDGenerator generates IDs.
S GetDefaultRequestedRangeSize Gets the default values for the range of IDs that duplicas can request on the duplication master when IDGenerator generates IDs.

Class Hierarchy

nn::nex::DuplicatedObject
  nn::nex::IDGenerator

Revision History

2011/01/27
Initial version.

CONFIDENTIAL