omni::structuredlog::IdMode

Defined in omni/structuredlog/IStructuredLogSettings.h

enum class omni::structuredlog::IdMode

Names to control how the next event identifier is generated after each event message.

Values:

enumerator eRandom

Each event identifier will be completely random.

There will be no ordering relationship between any two events. This mode is useful when a sense of ordering is not needed but a very small probability of an event identifier collision is needed.

enumerator eSequential

Each event identifier will be incremented by one from the previous one.

When using a UUID identifier, this will increment the previous identifier by one starting from the rightmost value. When using a 64-bit identifier, this the previous identifier will just be incremented by one. This is useful when ordering is important and events may need to be sorted.

enumerator eFastSequential

Each event identifier will be incremented by one from the previous one, but a faster method will be used.

When using a UUID identifier, this will not produce an easily sortable set of identifiers, but it will be faster to produce versus the other methods. When using a 64-bit identifier, this mode is the same as IdMode::eSequential and will produce an easily sortable set of identifiers. This is useful when event handling performance is the most important.