IUniqueSequenceProvider TryGenerateManyConsecutiveSequenceIDs Method NFX Class Library

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

Tries to generate many consecutive IDs. If the reserved block gets exhausted, then the returned ID count may be less than requested.

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

ConsecutiveUniqueSequenceIDs TryGenerateManyConsecutiveSequenceIDs(
	string scopeName,
	string sequenceName,
	int idCount,
	Nullable<ulong> vicinity = 18446744073709551615,
	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
idCount
Type: OnlineSystem Int32
How many Consecutive IDs should the system try to reserve
vicinity (Optional)
Type: OnlineSystem Nullable OnlineUInt64 
The location on ID counter scale, the issuing 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: ConsecutiveUniqueSequenceIDs
The first uniqueID along with the number of Consecutive IDs that the system could allocate which can be less than requested number of IDs
See Also