io.netty.channel

Class DefaultFileRegion

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.channel.DefaultFileRegion

All Implemented Interfaces:

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.

Constructor Summary

Constructors

Constructor and Description
DefaultFileRegion(java.nio.channels.FileChannel file, long position, long count) Create a new instance
DefaultFileRegion(java.io.File f, long position, long count) Create a new instance using the given File.

Method Summary

Modifier and Type	Method and Description
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.
long	transfered() Return the bytes which was transfered already
long	transferTo(java.nio.channels.WritableByteChannel target, long position) Transfers the content of this file region to the specified channel.

Methods inherited from class io.netty.util.AbstractReferenceCounted

refCnt, release, release, retain, retain, 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, retain, retain

Constructor Detail

DefaultFileRegion

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

Create a new instance

Parameters:

file - the FileChannel which should be transfered

position - the position from which the transfer should start

count - the number of bytes to transfer

DefaultFileRegion

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

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

Parameters:

f - the File which should be transfered

position - the position from which the transfer should start

count - the number of bytes to transfer

Method Detail

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.

Throws:

java.io.IOException

position

public long position()

Description copied from interface: FileRegion

Returns the offset in the file where the transfer began.

Specified by:

position in interface FileRegion

count

public long count()

Description copied from interface: FileRegion

Returns the number of bytes to transfer.

Specified by:

count in interface FileRegion

transfered

public long transfered()

Description copied from interface: FileRegion

Return the bytes which was transfered already

Specified by:

transfered in interface FileRegion

transferTo

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

Description copied from interface: FileRegion

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

Specified by:

transferTo in interface FileRegion

Parameters:

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.

Throws:

java.io.IOException

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted