AsyncFSOutput (Apache HBase 2.1.0-cdh6.3.2 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

FanOutOneBlockAsyncDFSOutput, WrapperAsyncFSOutput
```
@InterfaceAudience.Private
public interface AsyncFSOutput
extends Closeable
```
Interface for asynchronous filesystem output stream.
The implementation is not required to be thread safe.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`buffered()` Return the current size of buffered data.
`void`	`close()` Close the file.
`CompletableFuture<Long>`	`flush(boolean sync)` Flush the buffer out.
`org.apache.hadoop.hdfs.protocol.DatanodeInfo[]`	`getPipeline()` Return current pipeline.
`boolean`	`isBroken()` Whether the stream is broken.
`void`	`recoverAndClose(CancelableProgressable reporter)` The close method when error occurred.
`void`	`write(byte[] b)` Just call write(b, 0, b.length).
`void`	`write(byte[] b, int off, int len)` Copy the data into the buffer.
`void`	`write(ByteBuffer bb)` Copy the data in the given `bb` into the buffer.
`void`	`writeInt(int i)` Write an int to the buffer.

- Method Detail
  - write
```
void write(byte[] b)
```
    Just call write(b, 0, b.length).
    
    See Also:
    
    write(byte[], int, int)
  - write
```
void write(byte[] b,
           int off,
           int len)
```
    Copy the data into the buffer. Note that you need to call flush(boolean) to flush the buffer manually.
  - writeInt
```
void writeInt(int i)
```
    Write an int to the buffer.
  - write
```
void write(ByteBuffer bb)
```
    Copy the data in the given bb into the buffer.
  - buffered
```
int buffered()
```
    Return the current size of buffered data.
  - isBroken
```
boolean isBroken()
```
    Whether the stream is broken.
  - getPipeline
```
org.apache.hadoop.hdfs.protocol.DatanodeInfo[] getPipeline()
```
    Return current pipeline. Empty array if no pipeline.
  - flush
```
CompletableFuture<Long> flush(boolean sync)
```
    Flush the buffer out.
    
    Parameters:
    
    sync - persistent the data to device
    
    Returns:
    
    A CompletableFuture that hold the acked length after flushing.
  - recoverAndClose
```
void recoverAndClose(CancelableProgressable reporter)
              throws IOException
```
    The close method when error occurred.
    
    Throws:
    
    IOException
  - close
```
void close()
    throws IOException
```
    Close the file. You should call recoverAndClose(CancelableProgressable) if this method throws an exception.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Throws:
    
    IOException

Interface AsyncFSOutput

Method Summary

Method Detail

write

write

writeInt

write

buffered

isBroken

getPipeline

flush

recoverAndClose

close