ChunkedNioFile (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChunkedInput < ByteBuf >
```
public class ChunkedNioFile
extends java.lang.Object
implements ChunkedInput<ByteBuf>
```
A ChunkedInput ，使用NIO FileChannel通过块从文件块中提取数据。
如果您的操作系统支持zero-copy file transfer，例如sendfile() ，则可能需要使用FileRegion 。

构造方法摘要

构造方法
Constructor and Description
`ChunkedNioFile(java.io.File in)` 创建一个从指定文件中提取数据的新实例。
`ChunkedNioFile(java.nio.channels.FileChannel in)` 创建一个从指定文件中提取数据的新实例。
`ChunkedNioFile(java.nio.channels.FileChannel in, int chunkSize)` 创建一个从指定文件中提取数据的新实例。
`ChunkedNioFile(java.nio.channels.FileChannel in, long offset, long length, int chunkSize)` 创建一个从指定文件中提取数据的新实例。
`ChunkedNioFile(java.io.File in, int chunkSize)` 创建一个从指定文件中提取数据的新实例。

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`void`	`close()` 释放与输入相关的资源。
`long`	`currentOffset()` 返回当前正在进行传输的文件中的偏移量。
`long`	`endOffset()` 返回传输将结束的文件中的偏移量。
`boolean`	`isEndOfInput()` 返回 `true`当且仅当数据流中没有剩余数据且数据流已达到其结尾时。
`long`	`length()` 返回输入的长度。
`long`	`progress()` 返回当前传输进度。
`ByteBuf`	`readChunk(ByteBufAllocator allocator)` 从流中获取分块的数据。
`ByteBuf`	`readChunk(ChannelHandlerContext ctx)` 已过时。
`long`	`startOffset()` 返回传输开始的文件中的偏移量。

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

- 构造方法详细信息
  - ChunkedNioFile
```
public ChunkedNioFile(java.io.File in)
               throws java.io.IOException
```
    创建一个从指定文件中提取数据的新实例。
    
    异常
    
    java.io.IOException
  - ChunkedNioFile
```
public ChunkedNioFile(java.io.File in,
                      int chunkSize)
               throws java.io.IOException
```
    创建一个从指定文件中提取数据的新实例。
    
    参数
    
    chunkSize - 每个 readChunk(ChannelHandlerContext)调用中要获取的字节数
    
    异常
    
    java.io.IOException
  - ChunkedNioFile
```
public ChunkedNioFile(java.nio.channels.FileChannel in)
               throws java.io.IOException
```
    创建一个从指定文件中提取数据的新实例。
    
    异常
    
    java.io.IOException
  - ChunkedNioFile
```
public ChunkedNioFile(java.nio.channels.FileChannel in,
                      int chunkSize)
               throws java.io.IOException
```
    创建一个从指定文件中提取数据的新实例。
    
    参数
    
    chunkSize - 每个 readChunk(ChannelHandlerContext)调用中要获取的字节数
    
    异常
    
    java.io.IOException
  - ChunkedNioFile
```
public ChunkedNioFile(java.nio.channels.FileChannel in,
                      long offset,
                      long length,
                      int chunkSize)
               throws java.io.IOException
```
    创建一个从指定文件中提取数据的新实例。
    
    参数
    
    offset - 传输开始的文件的偏移量
    
    length - 要传输的字节数
    
    chunkSize - 每个 readChunk(ChannelHandlerContext)调用中要获取的字节数
    
    异常
    
    java.io.IOException
- 方法详细信息
  - startOffset
```
public long startOffset()
```
    返回传输开始的文件中的偏移量。
  - endOffset
```
public long endOffset()
```
    返回传输将结束的文件中的偏移量。
  - currentOffset
```
public long currentOffset()
```
    返回当前正在进行传输的文件中的偏移量。
  - isEndOfInput
```
public boolean isEndOfInput()
                     throws java.lang.Exception
```
    从接口ChunkedInput复制的描述
    
    返回 true当且仅当数据流中没有剩余数据且数据流已达到其结尾时。
    
    Specified by:
    
    isEndOfInput在界面 ChunkedInput<ByteBuf>
    
    异常
    
    java.lang.Exception
  - close
```
public void close()
           throws java.lang.Exception
```
    从接口ChunkedInput复制的描述
    
    释放与输入相关的资源。
    
    Specified by:
    
    close在界面 ChunkedInput<ByteBuf>
    
    异常
    
    java.lang.Exception
  - readChunk
```
@Deprecated
public ByteBuf readChunk(ChannelHandlerContext ctx)
                              throws java.lang.Exception
```
    已过时。
    
    Specified by:
    
    readChunk在界面 ChunkedInput<ByteBuf>
    
    参数
    
    ctx -它提供了一个上下文ByteBufAllocator如果缓冲区分配是必要的。
    
    结果
    
    获取的块。 null如果流中没有剩余数据。请注意， null并不一定意味着该流已达到其结尾。在缓慢的流中，下一个块可能暂时不可用。
    
    异常
    
    java.lang.Exception
  - readChunk
```
public ByteBuf readChunk(ByteBufAllocator allocator)
                  throws java.lang.Exception
```
    从接口ChunkedInput复制的描述
    
    从流中获取分块的数据。一旦此方法返回最后一个块并因此流到达末尾，任何后续的ChunkedInput.isEndOfInput()调用都必须返回true 。
    
    Specified by:
    
    readChunk在界面 ChunkedInput<ByteBuf>
    
    参数
    
    allocator - ByteBufAllocator如果缓冲区分配是必要的。
    
    结果
    
    获取的块。 null如果数据流中没有剩余数据。请注意， null并不一定意味着该流已到达结尾。在缓慢的流中，下一个块可能暂时不可用。
    
    异常
    
    java.lang.Exception
  - length
```
public long length()
```
    从接口ChunkedInput复制的描述
    
    返回输入的长度。
    
    Specified by:
    
    length在界面 ChunkedInput<ByteBuf>
    
    结果
    
    如果输入的长度已知，则输入的长度。如果输入的长度未知，则为负值。
  - progress
```
public long progress()
```
    从接口ChunkedInput复制的描述
    
    返回当前传输进度。
    
    Specified by:
    
    progress ，界面 ChunkedInput<ByteBuf>

Class ChunkedNioFile

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

构造方法详细信息

ChunkedNioFile

ChunkedNioFile

ChunkedNioFile

ChunkedNioFile

ChunkedNioFile

方法详细信息

startOffset

endOffset

currentOffset

isEndOfInput

close

readChunk

readChunk

length

progress