DefaultFileRegion (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.util.AbstractReferenceCounted
- - io.netty.channel.DefaultFileRegion

All Implemented Interfaces:

FileRegion ， ReferenceCounted
```
public class DefaultFileRegion
extends AbstractReferenceCounted
implements FileRegion
```
从FileChannel或File传输数据的默认FileRegion实现。请注意， FileChannel将自动关闭一次AbstractReferenceCounted.refCnt()返回0 。

构造方法摘要

构造方法
Constructor and Description
`DefaultFileRegion(java.nio.channels.FileChannel file, long position, long count)` 创建一个新的实例
`DefaultFileRegion(java.io.File f, long position, long count)` 使用给定的 `File`创建一个新实例。

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`long`	`count()` 返回要传输的字节数。
`protected void`	`deallocate()` 一次调用 `AbstractReferenceCounted.refCnt()`等于0。
`boolean`	`isOpen()` 如果`FileRegion`具有打开的文件描述符，则返回`true`
`void`	`open()` 如果尚未完成，则显式打开底层的文件描述符。
`long`	`position()` 返回传输开始的文件中的偏移量。
`FileRegion`	`retain()` 将引用计数增加 `1` 。
`FileRegion`	`retain(int increment)` 将参考计数增加指定的 `increment` 。
`FileRegion`	`touch()` 记录此对象的当前访问位置以进行调试。
`FileRegion`	`touch(java.lang.Object hint)` 记录此对象的当前访问位置，并附加一些用于调试的任意信息。
`long`	`transfered()` 已过时。
`long`	`transferred()` 返回已经传输的字节。
`long`	`transferTo(java.nio.channels.WritableByteChannel target, long position)` 将此文件区域的内容传输到指定的通道。

Methods inherited from class io.netty.util.AbstractReferenceCounted
refCnt, release, release, setRefCnt

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

Methods inherited from interface io.netty.util.ReferenceCounted
refCnt, release, release

- 构造方法详细信息
  - DefaultFileRegion
```
public DefaultFileRegion(java.nio.channels.FileChannel file,
                         long position,
                         long count)
```
    创建一个新的实例
    
    参数
    
    file - 应该转移的 FileChannel
    
    position - 转移开始的位置
    
    count - 要传输的字节数
  - DefaultFileRegion
```
public DefaultFileRegion(java.io.File f,
                         long position,
                         long count)
```
    使用给定的File创建一个新实例。 File将通过open()延迟或明确打开。
    
    参数
    
    f - 应该转移的 File
    
    position - 转移开始的位置
    
    count - 要传输的字节数
- 方法详细信息
  - isOpen
```
public boolean isOpen()
```
    如果FileRegion具有打开的文件描述符，则返回true
  - open
```
public void open()
          throws java.io.IOException
```
    如果尚未完成，则显式打开底层的文件描述符。
    
    异常
    
    java.io.IOException
  - position
```
public long position()
```
    从界面复制的描述： FileRegion
    
    返回传输开始的文件中的偏移量。
    
    Specified by:
    
    position接口 FileRegion
  - count
```
public long count()
```
    从界面复制的描述： FileRegion
    
    返回要传输的字节数。
    
    Specified by:
    
    count在界面 FileRegion
  - transfered
```
@Deprecated
public long transfered()
```
    已过时。
    
    从接口复制的描述： FileRegion
    
    返回已经传输的字节。
    
    Specified by:
    
    transfered在界面 FileRegion
  - transferred
```
public long transferred()
```
    从接口复制的描述： FileRegion
    
    返回已经传输的字节。
    
    Specified by:
    
    transferred在界面 FileRegion
  - transferTo
```
public long transferTo(java.nio.channels.WritableByteChannel target,
                       long position)
                throws java.io.IOException
```
    从界面复制的描述： FileRegion
    
    将此文件区域的内容传输到指定的通道。
    
    Specified by:
    
    transferTo接口 FileRegion
    
    参数
    
    target - 转账的目的地
    
    position - 传输从其开始的文件的相对偏移量。例如， 0将使传输从第FileRegion.position()个字节开始， FileRegion.count() - 1将使该区域的最后一个字节传输。
    
    异常
    
    java.io.IOException
  - deallocate
```
protected void deallocate()
```
    从类复制的描述： AbstractReferenceCounted
    
    一次调用 AbstractReferenceCounted.refCnt()等于0。
    
    Specified by:
    
    deallocate在课程 AbstractReferenceCounted
  - retain
```
public FileRegion retain()
```
    从接口复制的描述： ReferenceCounted
    
    将引用计数增加 1 。
    
    Specified by:
    
    retain在界面 FileRegion
    
    Specified by:
    
    retain接口 ReferenceCounted
    
    重写：
    
    retain class AbstractReferenceCounted
  - retain
```
public FileRegion retain(int increment)
```
    从接口复制的描述： ReferenceCounted
    
    将参考计数增加指定的 increment 。
    
    Specified by:
    
    retain接口 FileRegion
    
    Specified by:
    
    retain在界面 ReferenceCounted
    
    重写：
    
    retain在课堂上 AbstractReferenceCounted
  - touch
```
public FileRegion touch()
```
    从接口复制的描述： ReferenceCounted
    
    记录此对象的当前访问位置以进行调试。如果确定此物体泄漏，则通过此操作记录的信息将通过ResourceLeakDetector提供给您。此方法是touch(null)的快捷方式。
    
    Specified by:
    
    touch ，界面 FileRegion
    
    Specified by:
    
    touch在界面 ReferenceCounted
    
    重写：
    
    touch在课堂上 AbstractReferenceCounted
  - touch
```
public FileRegion touch(java.lang.Object hint)
```
    从界面复制的描述： ReferenceCounted
    
    记录此对象的当前访问位置，并附加一些用于调试的任意信息。如果确定此物体泄漏，则通过此操作记录的信息将通过ResourceLeakDetector提供给您。
    
    Specified by:
    
    touch接口 FileRegion
    
    Specified by:
    
    touch接口 ReferenceCounted

Class DefaultFileRegion

构造方法摘要

方法摘要

Methods inherited from class io.netty.util.AbstractReferenceCounted

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.ReferenceCounted

构造方法详细信息

DefaultFileRegion

DefaultFileRegion

方法详细信息

isOpen

open

position

count

transfered

transferred

transferTo

deallocate

retain

retain

touch

touch