StateMachine.DataChannel (Apache Ratis Server API 3.1.3 API)

所有超级接口:

AutoCloseable, Channel, Closeable, WritableByteChannel

封闭接口:

StateMachine
```
public static interface StateMachine.DataChannel
extends WritableByteChannel
```
For write state machine data.

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`void`	`force(boolean metadata)` Similar to `FileChannel.force(boolean)`, the underlying implementation should force writing the data and/or metadata to the underlying storage.
`default int`	`write(ByteBuffer buffer)` This method is the same as `WritableByteChannel.write(ByteBuffer)`.
`default int`	`write(ReferenceCountedObject<ByteBuffer> referenceCountedBuffer)` Similar to `write(ByteBuffer)` except that the parameter is a `ReferenceCountedObject`.

从接口继承的方法 java.nio.channels.Channel
close, isOpen

- 方法详细资料
  - write
```
default int write(ByteBuffer buffer)
           throws IOException
```
    This method is the same as WritableByteChannel.write(ByteBuffer). If the implementation has overridden write(ReferenceCountedObject), then it does not have to override this method.
    
    指定者:
    
    write 在接口中 WritableByteChannel
    
    抛出:
    
    IOException
  - write
```
default int write(ReferenceCountedObject<ByteBuffer> referenceCountedBuffer)
           throws IOException
```
    Similar to write(ByteBuffer) except that the parameter is a ReferenceCountedObject. This is an optional method. The default implementation is the same as write(referenceCountedBuffer.get()). The implementation may choose to override this method in order to retain the buffer for later use. - If the buffer is retained, it must be released afterward. Otherwise, the buffer will not be returned, and it will cause a memory leak. - If the buffer is retained multiple times, it must be released the same number of time. - It is safe to access the buffer before this method returns with or without retaining it. - If the buffer is not retained but is accessed after this method returns, the content of the buffer could possibly be changed unexpectedly, and it will cause data corruption.
    
    抛出:
    
    IOException
  - force
```
void force(boolean metadata)
    throws IOException
```
    Similar to FileChannel.force(boolean), the underlying implementation should force writing the data and/or metadata to the underlying storage.
    
    参数:
    
    metadata - Should the metadata be forced?
    
    抛出:
    
    IOException - If there are IO errors.

接口 StateMachine.DataChannel

方法概要

从接口继承的方法 java.nio.channels.Channel

方法详细资料

write

write

force