org.rocksdb

Class Env

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.Env

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

RocksEnv, RocksMemEnv

public abstract class Env
extends RocksObject

Base class for all Env implementations in RocksDB.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPACTION_POOL
static int	FLUSH_POOL

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Env(long nativeHandle)

Method Summary

Modifier and Type	Method and Description
static Env	getDefault() Returns the default environment suitable for the current operating system.
int	getThreadPoolQueueLen(int poolID) Returns the length of the queue associated with the specified thread pool.
Env	setBackgroundThreads(int num) Sets the number of background worker threads of the flush pool for this environment.
Env	setBackgroundThreads(int num, int poolID) Sets the number of background worker threads of the specified thread pool for this environment.

Methods inherited from class org.rocksdb.RocksObject

disposeInternal, disposeInternal

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference

close, disOwnNativeHandle, isOwningHandle

Methods inherited from class org.rocksdb.AbstractNativeReference

dispose, finalize

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLUSH_POOL

public static final int FLUSH_POOL

See Also:

Constant Field Values

COMPACTION_POOL

public static final int COMPACTION_POOL

See Also:

Constant Field Values

Constructor Detail

Env

protected Env(long nativeHandle)

Method Detail

getDefault

public static Env getDefault()

Returns the default environment suitable for the current operating system.

The result of getDefault() is a singleton whose ownership belongs to rocksdb c++. As a result, the returned RocksEnv will not have the ownership of its c++ resource, and calling its dispose() will be no-op.

Returns:

the default RocksEnv instance.

setBackgroundThreads

public Env setBackgroundThreads(int num)

Sets the number of background worker threads of the flush pool for this environment.

Default number: 1

Parameters:

num - the number of threads

Returns:

current RocksEnv instance.

setBackgroundThreads

public Env setBackgroundThreads(int num,
                                int poolID)

Sets the number of background worker threads of the specified thread pool for this environment.

Parameters:

num - the number of threads

poolID - the id to specified a thread pool. Should be either FLUSH_POOL or COMPACTION_POOL.

Default number: 1

Returns:

current RocksEnv instance.

getThreadPoolQueueLen

public int getThreadPoolQueueLen(int poolID)

Returns the length of the queue associated with the specified thread pool.

Parameters:

poolID - the id to specified a thread pool. Should be either FLUSH_POOL or COMPACTION_POOL.

Returns:

the thread pool queue length.