java.lang.Object
- io.netty5.handler.stream.ChunkedNioFile

All Implemented Interfaces:

ChunkedInput<Buffer>, AutoCloseable
```
public class ChunkedNioFile
extends Object
implements ChunkedInput<Buffer>
```
A ChunkedInput that fetches data from a file chunk by chunk using NIO FileChannel.
If your operating system supports zero-copy file transfer such as sendfile(), you might want to use FileRegion instead.

Constructor Summary

Constructors
Constructor	Description
`ChunkedNioFile(File in)`	Creates a new instance that fetches data from the specified file.
`ChunkedNioFile(File in, int chunkSize)`	Creates a new instance that fetches data from the specified file.
`ChunkedNioFile(FileChannel in)`	Creates a new instance that fetches data from the specified file.
`ChunkedNioFile(FileChannel in, int chunkSize)`	Creates a new instance that fetches data from the specified file.
`ChunkedNioFile(FileChannel in, long offset, long length, int chunkSize)`	Creates a new instance that fetches data from the specified file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`long`	`currentOffset()`	Returns the offset in the file where the transfer is happening currently.
`long`	`endOffset()`	Returns the offset in the file where the transfer will end.
`boolean`	`isEndOfInput()`	Return `true` if and only if there is no data left in the stream and the stream has reached at its end.
`long`	`length()`	Returns the length of the input.
`long`	`progress()`	Returns current transfer progress.
`Buffer`	`readChunk(BufferAllocator allocator)`	Fetches a chunked data from the stream.
`long`	`startOffset()`	Returns the offset in the file where the transfer began.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChunkedNioFile
```
public ChunkedNioFile(File in)
               throws IOException
```
    Creates a new instance that fetches data from the specified file.
    
    Throws:
    
    IOException
  - ChunkedNioFile
```
public ChunkedNioFile(File in,
                      int chunkSize)
               throws IOException
```
    Creates a new instance that fetches data from the specified file.
    
    Parameters:
    
    chunkSize - the number of bytes to fetch on each readChunk(BufferAllocator) call.
    
    Throws:
    
    IOException
  - ChunkedNioFile
```
public ChunkedNioFile(FileChannel in)
               throws IOException
```
    Creates a new instance that fetches data from the specified file.
    
    Throws:
    
    IOException
  - ChunkedNioFile
```
public ChunkedNioFile(FileChannel in,
                      int chunkSize)
               throws IOException
```
    Creates a new instance that fetches data from the specified file.
    
    Parameters:
    
    chunkSize - the number of bytes to fetch on each readChunk(BufferAllocator) call.
    
    Throws:
    
    IOException
  - ChunkedNioFile
```
public ChunkedNioFile(FileChannel in,
                      long offset,
                      long length,
                      int chunkSize)
               throws IOException
```
    Creates a new instance that fetches data from the specified file.
    
    Parameters:
    
    offset - the offset of the file where the transfer begins
    
    length - the number of bytes to transfer
    
    chunkSize - the number of bytes to fetch on each readChunk(BufferAllocator) call.
    
    Throws:
    
    IOException
- Method Detail
  - startOffset
```
public long startOffset()
```
    Returns the offset in the file where the transfer began.
  - endOffset
```
public long endOffset()
```
    Returns the offset in the file where the transfer will end.
  - currentOffset
```
public long currentOffset()
```
    Returns the offset in the file where the transfer is happening currently.
  - isEndOfInput
```
public boolean isEndOfInput()
                     throws Exception
```
    Description copied from interface: ChunkedInput
    
    Return true if and only if there is no data left in the stream and the stream has reached at its end.
    
    Specified by:
    
    isEndOfInput in interface ChunkedInput<Buffer>
    
    Throws:
    
    Exception
  - close
```
public void close()
           throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - readChunk
```
public Buffer readChunk(BufferAllocator allocator)
                 throws Exception
```
    Description copied from interface: ChunkedInput
    
    Fetches a chunked data from the stream. Once this method returns the last chunk and thus the stream has reached at its end, any subsequent ChunkedInput.isEndOfInput() call must return true.
    
    Specified by:
    
    readChunk in interface ChunkedInput<Buffer>
    
    Parameters:
    
    allocator - BufferAllocator if buffer allocation is necessary.
    
    Returns:
    
    the fetched chunk. null if there is no data left in the stream. Please note that null does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.
    
    Throws:
    
    Exception
  - length
```
public long length()
```
    Description copied from interface: ChunkedInput
    
    Returns the length of the input.
    
    Specified by:
    
    length in interface ChunkedInput<Buffer>
    
    Returns:
    
    the length of the input if the length of the input is known. a negative value if the length of the input is unknown.
  - progress
```
public long progress()
```
    Description copied from interface: ChunkedInput
    
    Returns current transfer progress.
    
    Specified by:
    
    progress in interface ChunkedInput<Buffer>

Class ChunkedNioFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChunkedNioFile

ChunkedNioFile

ChunkedNioFile

ChunkedNioFile

ChunkedNioFile

Method Detail

startOffset

endOffset

currentOffset

isEndOfInput

close

readChunk

length

progress