io.netty.channel

类 DefaultFileRegion

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.channel.DefaultFileRegion

所有已实现的接口:

FileRegion, ReferenceCounted

public class DefaultFileRegion
extends AbstractReferenceCounted
implements FileRegion

Default FileRegion implementation which transfer data from a FileChannel or File. Be aware that the FileChannel will be automatically closed once AbstractReferenceCounted.refCnt() returns 0.

构造器概要

构造器

构造器和说明
DefaultFileRegion(java.nio.channels.FileChannel fileChannel, long position, long count) Create a new instance
DefaultFileRegion(java.io.File file, long position, long count) Create a new instance using the given File.

方法概要

限定符和类型	方法和说明
long	count() Returns the number of bytes to transfer.
protected void	deallocate() Called once AbstractReferenceCounted.refCnt() is equals 0.
boolean	isOpen() Returns true if the FileRegion has a open file-descriptor
void	open() Explicitly open the underlying file-descriptor if not done yet.
long	position() Returns the offset in the file where the transfer began.
FileRegion	retain() Increases the reference count by 1.
FileRegion	retain(int increment) Increases the reference count by the specified increment.
FileRegion	touch() Records the current access location of this object for debugging purposes.
FileRegion	touch(java.lang.Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.
long	transfered() 已过时。
long	transferred() Returns the bytes which was transferred already.
long	transferTo(java.nio.channels.WritableByteChannel target, long position) Transfers the content of this file region to the specified channel.

从类继承的方法 io.netty.util.AbstractReferenceCounted

refCnt, release, release, setRefCnt

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.netty.util.ReferenceCounted

refCnt, release, release

构造器详细资料

DefaultFileRegion

public DefaultFileRegion(java.nio.channels.FileChannel fileChannel,
                         long position,
                         long count)

Create a new instance

参数:

fileChannel - the FileChannel which should be transferred

position - the position from which the transfer should start

count - the number of bytes to transfer

DefaultFileRegion

public DefaultFileRegion(java.io.File file,
                         long position,
                         long count)

Create a new instance using the given File. The File will be opened lazily or explicitly via open().

参数:

file - the File which should be transferred

position - the position from which the transfer should start

count - the number of bytes to transfer

方法详细资料

isOpen

public boolean isOpen()

Returns true if the FileRegion has a open file-descriptor

open

public void open()
          throws java.io.IOException

Explicitly open the underlying file-descriptor if not done yet.

抛出:

java.io.IOException

position

public long position()

从接口复制的说明: FileRegion

Returns the offset in the file where the transfer began.

指定者:

position 在接口中 FileRegion

count

public long count()

从接口复制的说明: FileRegion

Returns the number of bytes to transfer.

指定者:

count 在接口中 FileRegion

transfered

@Deprecated
public long transfered()

已过时。

从接口复制的说明: FileRegion

Returns the bytes which was transferred already.

指定者:

transfered 在接口中 FileRegion

transferred

public long transferred()

从接口复制的说明: FileRegion

Returns the bytes which was transferred already.

指定者:

transferred 在接口中 FileRegion

transferTo

public long transferTo(java.nio.channels.WritableByteChannel target,
                       long position)
                throws java.io.IOException

从接口复制的说明: FileRegion

Transfers the content of this file region to the specified channel.

指定者:

transferTo 在接口中 FileRegion

参数:

target - the destination of the transfer

position - the relative offset of the file where the transfer begins from. For example, 0 will make the transfer start from FileRegion.position()th byte and FileRegion.count() - 1 will make the last byte of the region transferred.

抛出:

java.io.IOException

deallocate

protected void deallocate()

从类复制的说明: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

指定者:

deallocate 在类中 AbstractReferenceCounted

retain

public FileRegion retain()

从接口复制的说明: ReferenceCounted

Increases the reference count by 1.

指定者:

retain 在接口中 FileRegion

指定者:

retain 在接口中 ReferenceCounted

覆盖:

retain 在类中 AbstractReferenceCounted

retain

public FileRegion retain(int increment)

从接口复制的说明: ReferenceCounted

Increases the reference count by the specified increment.

指定者:

retain 在接口中 FileRegion

指定者:

retain 在接口中 ReferenceCounted

覆盖:

retain 在类中 AbstractReferenceCounted

touch

public FileRegion touch()

从接口复制的说明: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

指定者:

touch 在接口中 FileRegion

指定者:

touch 在接口中 ReferenceCounted

覆盖:

touch 在类中 AbstractReferenceCounted

touch

public FileRegion touch(java.lang.Object hint)

从接口复制的说明: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

指定者:

touch 在接口中 FileRegion

指定者:

touch 在接口中 ReferenceCounted