AbstractEventListener

java.lang.Object
- org.rocksdb.AbstractNativeReference
- - org.rocksdb.AbstractImmutableNativeReference
  - - org.rocksdb.RocksCallbackObject
    - - org.rocksdb.AbstractEventListener

所有已实现的接口:: java.lang.AutoCloseable, EventListener

public abstract class AbstractEventListener
extends RocksCallbackObject
implements EventListener

Base class for Event Listeners.

嵌套类概要

嵌套类
限定符和类型类和说明

static class AbstractEventListener.EnabledEventCallback

嵌套类
限定符和类型	类和说明
`static class`	`AbstractEventListener.EnabledEventCallback`

字段概要
- 从类继承的字段 org.rocksdb.RocksCallbackObject
  nativeHandle_
- 从类继承的字段 org.rocksdb.AbstractImmutableNativeReference
  owningHandle_

构造器概要

构造器
限定符	构造器和说明
`protected`	`AbstractEventListener()` Creates an Event Listener that will receive all callbacks from C++.
`protected`	`AbstractEventListener(AbstractEventListener.EnabledEventCallback... enabledEventCallbacks)` Creates an Event Listener that will receive only certain callbacks from C++.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`disposeInternal()` Deletes underlying C++ native callback object pointer
`protected long`	`initializeNative(long... nativeParameterHandles)` Construct the Native C++ object which will callback to our object methods
`void`	`onBackgroundError(BackgroundErrorReason backgroundErrorReason, Status backgroundError)` A callback function for RocksDB which will be called before setting the background error status to a non-OK value.
`void`	`onColumnFamilyHandleDeletionStarted(ColumnFamilyHandle columnFamilyHandle)` A callback function for RocksDB which will be called before a column family handle is deleted.
`void`	`onCompactionBegin(RocksDB db, CompactionJobInfo compactionJobInfo)` A callback function to RocksDB which will be called before a RocksDB starts to compact.
`void`	`onCompactionCompleted(RocksDB db, CompactionJobInfo compactionJobInfo)` A callback function for RocksDB which will be called whenever a registered RocksDB compacts a file.
`boolean`	`onErrorRecoveryBegin(BackgroundErrorReason backgroundErrorReason, Status backgroundError)` A callback function for RocksDB which will be called just before starting the automatic recovery process for recoverable background errors, such as NoSpace().
`void`	`onErrorRecoveryCompleted(Status oldBackgroundError)` A callback function for RocksDB which will be called once the database is recovered from read-only mode after an error.
`void`	`onExternalFileIngested(RocksDB db, ExternalFileIngestionInfo externalFileIngestionInfo)` A callback function for RocksDB which will be called after an external file is ingested using IngestExternalFile.
`void`	`onFileCloseFinish(FileOperationInfo fileOperationInfo)` A callback function for RocksDB which will be called whenever a file close operation finishes.
`void`	`onFileFlushFinish(FileOperationInfo fileOperationInfo)` A callback function for RocksDB which will be called whenever a file flush operation finishes.
`void`	`onFileRangeSyncFinish(FileOperationInfo fileOperationInfo)` A callback function for RocksDB which will be called whenever a file rangeSync operation finishes.
`void`	`onFileReadFinish(FileOperationInfo fileOperationInfo)` A callback function for RocksDB which will be called whenever a file read operation finishes.
`void`	`onFileSyncFinish(FileOperationInfo fileOperationInfo)` A callback function for RocksDB which will be called whenever a file sync operation finishes.
`void`	`onFileTruncateFinish(FileOperationInfo fileOperationInfo)` A callback function for RocksDB which will be called whenever a file truncate operation finishes.
`void`	`onFileWriteFinish(FileOperationInfo fileOperationInfo)` A callback function for RocksDB which will be called whenever a file write operation finishes.
`void`	`onFlushBegin(RocksDB db, FlushJobInfo flushJobInfo)` A callback function to RocksDB which will be called before a RocksDB starts to flush memtables.
`void`	`onFlushCompleted(RocksDB db, FlushJobInfo flushJobInfo)` callback function to RocksDB which will be called whenever a registered RocksDB flushes a file.
`void`	`onMemTableSealed(MemTableInfo memTableInfo)` A callback function for RocksDB which will be called before a memtable is made immutable.
`void`	`onStallConditionsChanged(WriteStallInfo writeStallInfo)` A callback function for RocksDB which will be called whenever a change of superversion triggers a change of the stall conditions.
`void`	`onTableFileCreated(TableFileCreationInfo tableFileCreationInfo)` A callback function for RocksDB which will be called whenever a SST file is created.
`void`	`onTableFileCreationStarted(TableFileCreationBriefInfo tableFileCreationBriefInfo)` A callback function for RocksDB which will be called before a SST file is being created.
`void`	`onTableFileDeleted(TableFileDeletionInfo tableFileDeletionInfo)` A callback function for RocksDB which will be called whenever a SST file is deleted.
`boolean`	`shouldBeNotifiedOnFileIO()` If true, the `EventListener.onFileReadFinish(FileOperationInfo)` and `EventListener.onFileWriteFinish(FileOperationInfo)` will be called.

从类继承的方法 org.rocksdb.AbstractImmutableNativeReference
close, disOwnNativeHandle, isOwningHandle

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AbstractEventListener
```
protected AbstractEventListener()
```
    Creates an Event Listener that will receive all callbacks from C++.
    If you don't need all callbacks, it is much more efficient to just register for the ones you need by calling AbstractEventListener(EnabledEventCallback...) instead.
  - AbstractEventListener
```
protected AbstractEventListener(AbstractEventListener.EnabledEventCallback... enabledEventCallbacks)
```
    Creates an Event Listener that will receive only certain callbacks from C++.
    
    参数:
    
    enabledEventCallbacks - callbacks to enable in Java.
- 方法详细资料
  - onFlushCompleted
```
public void onFlushCompleted(RocksDB db,
                             FlushJobInfo flushJobInfo)
```
    从接口复制的说明: EventListener
    
    callback function to RocksDB which will be called whenever a registered RocksDB flushes a file.
    Note that the this function must be implemented in a way such that it should not run for an extended period of time before the function returns. Otherwise, RocksDB may be blocked.
    
    指定者:
    
    onFlushCompleted 在接口中 EventListener
    
    参数:
    
    db - the database
    
    flushJobInfo - the flush job info, contains data copied from respective native structure.
  - onFlushBegin
```
public void onFlushBegin(RocksDB db,
                         FlushJobInfo flushJobInfo)
```
    从接口复制的说明: EventListener
    
    A callback function to RocksDB which will be called before a RocksDB starts to flush memtables.
    Note that the this function must be implemented in a way such that it should not run for an extended period of time before the function returns. Otherwise, RocksDB may be blocked.
    
    指定者:
    
    onFlushBegin 在接口中 EventListener
    
    参数:
    
    db - the database
    
    flushJobInfo - the flush job info, contains data copied from respective native structure.
  - onTableFileDeleted
```
public void onTableFileDeleted(TableFileDeletionInfo tableFileDeletionInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a SST file is deleted. Different from EventListener.onCompactionCompleted(RocksDB, CompactionJobInfo) and EventListener.onFlushCompleted(RocksDB, FlushJobInfo), this callback is designed for external logging service and thus only provide string parameters instead of a pointer to DB. Applications that build logic basic based on file creations and deletions is suggested to implement EventListener.onFlushCompleted(RocksDB, FlushJobInfo) and EventListener.onCompactionCompleted(RocksDB, CompactionJobInfo).
    Note that if applications would like to use the passed reference outside this function call, they should make copies from the returned value.
    
    指定者:
    
    onTableFileDeleted 在接口中 EventListener
    
    参数:
    
    tableFileDeletionInfo - the table file deletion info, contains data copied from respective native structure.
  - onCompactionBegin
```
public void onCompactionBegin(RocksDB db,
                              CompactionJobInfo compactionJobInfo)
```
    从接口复制的说明: EventListener
    
    A callback function to RocksDB which will be called before a RocksDB starts to compact. The default implementation is no-op.
    Note that the this function must be implemented in a way such that it should not run for an extended period of time before the function returns. Otherwise, RocksDB may be blocked.
    
    指定者:
    
    onCompactionBegin 在接口中 EventListener
    
    参数:
    
    db - a pointer to the rocksdb instance which just compacted a file.
    
    compactionJobInfo - a reference to a native CompactionJobInfo struct, which is released after this function is returned, and must be copied if it is needed outside of this function.
  - onCompactionCompleted
```
public void onCompactionCompleted(RocksDB db,
                                  CompactionJobInfo compactionJobInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a registered RocksDB compacts a file. The default implementation is a no-op.
    Note that this function must be implemented in a way such that it should not run for an extended period of time before the function returns. Otherwise, RocksDB may be blocked.
    
    指定者:
    
    onCompactionCompleted 在接口中 EventListener
    
    参数:
    
    db - a pointer to the rocksdb instance which just compacted a file.
    
    compactionJobInfo - a reference to a native CompactionJobInfo struct, which is released after this function is returned, and must be copied if it is needed outside of this function.
  - onTableFileCreated
```
public void onTableFileCreated(TableFileCreationInfo tableFileCreationInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a SST file is created. Different from OnCompactionCompleted and OnFlushCompleted, this callback is designed for external logging service and thus only provide string parameters instead of a pointer to DB. Applications that build logic basic based on file creations and deletions is suggested to implement OnFlushCompleted and OnCompactionCompleted.
    Historically it will only be called if the file is successfully created. Now it will also be called on failure case. User can check info.status to see if it succeeded or not.
    Note that if applications would like to use the passed reference outside this function call, they should make copies from these returned value.
    
    指定者:
    
    onTableFileCreated 在接口中 EventListener
    
    参数:
    
    tableFileCreationInfo - the table file creation info, contains data copied from respective native structure.
  - onTableFileCreationStarted
```
public void onTableFileCreationStarted(TableFileCreationBriefInfo tableFileCreationBriefInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called before a SST file is being created. It will follow by OnTableFileCreated after the creation finishes.
    Note that if applications would like to use the passed reference outside this function call, they should make copies from these returned value.
    
    指定者:
    
    onTableFileCreationStarted 在接口中 EventListener
    
    参数:
    
    tableFileCreationBriefInfo - the table file creation brief info, contains data copied from respective native structure.
  - onMemTableSealed
```
public void onMemTableSealed(MemTableInfo memTableInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called before a memtable is made immutable.
    Note that the this function must be implemented in a way such that it should not run for an extended period of time before the function returns. Otherwise, RocksDB may be blocked.
    Note that if applications would like to use the passed reference outside this function call, they should make copies from these returned value.
    
    指定者:
    
    onMemTableSealed 在接口中 EventListener
    
    参数:
    
    memTableInfo - the mem table info, contains data copied from respective native structure.
  - onColumnFamilyHandleDeletionStarted
```
public void onColumnFamilyHandleDeletionStarted(ColumnFamilyHandle columnFamilyHandle)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called before a column family handle is deleted.
    Note that the this function must be implemented in a way such that it should not run for an extended period of time before the function returns. Otherwise, RocksDB may be blocked.
    
    指定者:
    
    onColumnFamilyHandleDeletionStarted 在接口中 EventListener
    
    参数:
    
    columnFamilyHandle - is a pointer to the column family handle to be deleted which will become a dangling pointer after the deletion.
  - onExternalFileIngested
```
public void onExternalFileIngested(RocksDB db,
                                   ExternalFileIngestionInfo externalFileIngestionInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called after an external file is ingested using IngestExternalFile.
    Note that the this function will run on the same thread as IngestExternalFile(), if this function is blocked, IngestExternalFile() will be blocked from finishing.
    
    指定者:
    
    onExternalFileIngested 在接口中 EventListener
    
    参数:
    
    db - the database
    
    externalFileIngestionInfo - the external file ingestion info, contains data copied from respective native structure.
  - onBackgroundError
```
public void onBackgroundError(BackgroundErrorReason backgroundErrorReason,
                              Status backgroundError)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called before setting the background error status to a non-OK value. The new background error status is provided in `bg_error` and can be modified by the callback. E.g., a callback can suppress errors by resetting it to Status::OK(), thus preventing the database from entering read-only mode. We do not provide any guarantee when failed flushes/compactions will be rescheduled if the user suppresses an error.
    Note that this function can run on the same threads as flush, compaction, and user writes. So, it is extremely important not to perform heavy computations or blocking calls in this function.
    
    指定者:
    
    onBackgroundError 在接口中 EventListener
    
    参数:
    
    backgroundErrorReason - background error reason code
    
    backgroundError - background error codes
  - onStallConditionsChanged
```
public void onStallConditionsChanged(WriteStallInfo writeStallInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a change of superversion triggers a change of the stall conditions.
    Note that the this function must be implemented in a way such that it should not run for an extended period of time before the function returns. Otherwise, RocksDB may be blocked.
    
    指定者:
    
    onStallConditionsChanged 在接口中 EventListener
    
    参数:
    
    writeStallInfo - write stall info, contains data copied from respective native structure.
  - onFileReadFinish
```
public void onFileReadFinish(FileOperationInfo fileOperationInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a file read operation finishes.
    
    指定者:
    
    onFileReadFinish 在接口中 EventListener
    
    参数:
    
    fileOperationInfo - file operation info, contains data copied from respective native structure.
  - onFileWriteFinish
```
public void onFileWriteFinish(FileOperationInfo fileOperationInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a file write operation finishes.
    
    指定者:
    
    onFileWriteFinish 在接口中 EventListener
    
    参数:
    
    fileOperationInfo - file operation info, contains data copied from respective native structure.
  - onFileFlushFinish
```
public void onFileFlushFinish(FileOperationInfo fileOperationInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a file flush operation finishes.
    
    指定者:
    
    onFileFlushFinish 在接口中 EventListener
    
    参数:
    
    fileOperationInfo - file operation info, contains data copied from respective native structure.
  - onFileSyncFinish
```
public void onFileSyncFinish(FileOperationInfo fileOperationInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a file sync operation finishes.
    
    指定者:
    
    onFileSyncFinish 在接口中 EventListener
    
    参数:
    
    fileOperationInfo - file operation info, contains data copied from respective native structure.
  - onFileRangeSyncFinish
```
public void onFileRangeSyncFinish(FileOperationInfo fileOperationInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a file rangeSync operation finishes.
    
    指定者:
    
    onFileRangeSyncFinish 在接口中 EventListener
    
    参数:
    
    fileOperationInfo - file operation info, contains data copied from respective native structure.
  - onFileTruncateFinish
```
public void onFileTruncateFinish(FileOperationInfo fileOperationInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a file truncate operation finishes.
    
    指定者:
    
    onFileTruncateFinish 在接口中 EventListener
    
    参数:
    
    fileOperationInfo - file operation info, contains data copied from respective native structure.
  - onFileCloseFinish
```
public void onFileCloseFinish(FileOperationInfo fileOperationInfo)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called whenever a file close operation finishes.
    
    指定者:
    
    onFileCloseFinish 在接口中 EventListener
    
    参数:
    
    fileOperationInfo - file operation info, contains data copied from respective native structure.
  - shouldBeNotifiedOnFileIO
```
public boolean shouldBeNotifiedOnFileIO()
```
    从接口复制的说明: EventListener
    
    If true, the EventListener.onFileReadFinish(FileOperationInfo) and EventListener.onFileWriteFinish(FileOperationInfo) will be called. If false, then they won't be called.
    Default: false
    
    指定者:
    
    shouldBeNotifiedOnFileIO 在接口中 EventListener
    
    返回:
    
    whether to callback when file read/write is finished
  - onErrorRecoveryBegin
```
public boolean onErrorRecoveryBegin(BackgroundErrorReason backgroundErrorReason,
                                    Status backgroundError)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called just before starting the automatic recovery process for recoverable background errors, such as NoSpace(). The callback can suppress the automatic recovery by setting returning false. The database will then have to be transitioned out of read-only mode by calling RocksDB#resume().
    
    指定者:
    
    onErrorRecoveryBegin 在接口中 EventListener
    
    参数:
    
    backgroundErrorReason - background error reason code
    
    backgroundError - background error codes
    
    返回:
    
    return false if the automatic recovery should be suppressed
  - onErrorRecoveryCompleted
```
public void onErrorRecoveryCompleted(Status oldBackgroundError)
```
    从接口复制的说明: EventListener
    
    A callback function for RocksDB which will be called once the database is recovered from read-only mode after an error. When this is called, it means normal writes to the database can be issued and the user can initiate any further recovery actions needed
    
    指定者:
    
    onErrorRecoveryCompleted 在接口中 EventListener
    
    参数:
    
    oldBackgroundError - old background error codes
  - initializeNative
```
protected long initializeNative(long... nativeParameterHandles)
```
    从类复制的说明: RocksCallbackObject
    
    Construct the Native C++ object which will callback to our object methods
    
    指定者:
    
    initializeNative 在类中 RocksCallbackObject
    
    参数:
    
    nativeParameterHandles - An array of native handles for any parameter objects that are needed during construction
    
    返回:
    
    The native handle of the C++ object which will callback to us
  - disposeInternal
```
protected void disposeInternal()
```
    Deletes underlying C++ native callback object pointer
    
    覆盖:
    
    disposeInternal 在类中 RocksCallbackObject

类 AbstractEventListener

嵌套类概要

字段概要

从类继承的字段 org.rocksdb.RocksCallbackObject

从类继承的字段 org.rocksdb.AbstractImmutableNativeReference

构造器概要

方法概要

从类继承的方法 org.rocksdb.AbstractImmutableNativeReference

从类继承的方法 java.lang.Object

构造器详细资料

AbstractEventListener

AbstractEventListener

方法详细资料

onFlushCompleted

onFlushBegin

onTableFileDeleted

onCompactionBegin

onCompactionCompleted

onTableFileCreated

onTableFileCreationStarted

onMemTableSealed

onColumnFamilyHandleDeletionStarted

onExternalFileIngested

onBackgroundError

onStallConditionsChanged

onFileReadFinish

onFileWriteFinish

onFileFlushFinish

onFileSyncFinish

onFileRangeSyncFinish

onFileTruncateFinish

onFileCloseFinish

shouldBeNotifiedOnFileIO

onErrorRecoveryBegin

onErrorRecoveryCompleted

initializeNative

disposeInternal