nn::nex::IDGenerator::GenerateID Member Function

Syntax

qBool GenerateID(
     ID * uiRetID,
     qUnsignedInt32 uiTimeout = WAIT_INFINITE_TIMEOUT
);

Parameters

Name Description
uiRetID [out] Specifies a pointer for accepting the ID number when generation succeeded.
uiTimeout [in] Specifies the maximum wait time in milliseconds that the system should wait for generation of the ID. (The default is no timeout.)

Return Values



Value Description
true Returned if the ID was accurately generated.
false Returned if generation failed, or if there was an error.

Description

Generates a usable, unique ID that can be used from the IDGenerator through all stations.

All IDGenerator objects (including duplication masters and duplicas) hold a local pool of IDs that can each be used. Before this pool becomes empty (when about 25 IDs have been used), a local pool of new IDs is requested by the duplication master.

If all valid IDs in the ID pool are used up, the station requests the duplication master for a new ID pool. At this time, this function blocks for a certain amount of time (an amount of time roughly equivalent to round trip time for communication with the duplication master).

Revision History

2011/01/27
Initial version.

CONFIDENTIAL