Enum RateLimiterPriority

Namespace

RocksDbNet

Assembly

RocksDb.Net.dll

The priority an operation is given by the rate limiter, if one is configured.

public enum RateLimiterPriority

Fields

High = 2

High priority.

Low = 0

Low priority, yielding to everything else. The default for background work.

Mid = 1

Between Low and High.

Total = 4

Do not charge the rate limiter for this operation. The default.

The name is RocksDb's: Env::IO_TOTAL is the count of real priorities, and RocksDb reuses it as the "no rate limiting" value rather than declaring a separate one. ReadOptions::rate_limiter_priority is declared as = Env::IO_TOTAL with the comment that the special value disables charging the rate limiter, so this is both the default and a meaningful thing to pass. This used to be documented as a programming error to use, which had it exactly backwards.

User = 3

User-facing work, which the rate limiter should not delay.

Remarks

Mirrored from Env::IOPriority in include/rocksdb/env.h because the C API declares this parameter as a plain int.