IGDIDProvider GenerateOneGDID Method NFX Class Library

[This is preliminary documentation and is subject to change.]

Generates Globally-Unique distributed ID (GDID) for the supplied sequence name. Note: do not confuse with block pre-allocation, which is an internal optimization. Even if 100 IDs are pre-allocated the method returns one unique GDID

Namespace: NFX.DataAccess
Assembly: NFX (in NFX.dll) Version: 3.0.0.1 (3.0.0.1)
Syntax

GDID GenerateOneGDID(
	string scopeName,
	string sequenceName,
	int blockSize = 0,
	Nullable<ulong> vicinity = 1152921504606846975,
	bool noLWM = false
)

Parameters

scopeName
Type: OnlineSystem String
The name of scope where sequences are kept
sequenceName
Type: OnlineSystem String
The name of sequence within the scope for which ID to be obtained
blockSize (Optional)
Type: OnlineSystem Int32
If >0 specifies how many sequence values to pre-allocate, otherwise provider would use its default setting
vicinity (Optional)
Type: OnlineSystem Nullable OnlineUInt64 
The location on ID counter scale, the authority may disregard this parameter
noLWM (Optional)
Type: OnlineSystem Boolean
When true, does not start async fetch of the next ID block while the current block reaches low-water-mark. This may not be desired in some short-lived processes. The provider may disregard this flag

Return Value

Type: GDID
The GDID instance
See Also