org.rocksdb

Class RocksEnv

java.lang.Object

org.rocksdb.RocksObject

org.rocksdb.RocksEnv

public class RocksEnv
extends RocksObject

A RocksEnv is an interface used by the rocksdb implementation to access operating system functionality like the filesystem etc.

All Env implementations are safe for concurrent access from multiple threads without any external synchronization.

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_

Method Summary

Modifier and Type	Method and Description
protected void	disposeInternal() The helper function of RocksObject.dispose() which all subclasses of RocksObject must implement to release their associated C++ resource.
static RocksEnv	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.
RocksEnv	setBackgroundThreads(int num) Sets the number of background worker threads of the flush pool for this environment.
RocksEnv	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

disOwnNativeHandle, dispose, finalize, isInitialized, isOwningNativeHandle

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

Method Detail

getDefault

public static RocksEnv 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 RocksEnv 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 RocksEnv 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.

disposeInternal

protected void disposeInternal()

The helper function of RocksObject.dispose() which all subclasses of RocksObject must implement to release their associated C++ resource.

Specified by:

disposeInternal in class RocksObject