Top Description Methods
org.apache.hc.core5.http.nio

public Interface FileContentDecoder

extends ContentDecoder
Known Direct Implementers
org.apache.hc.core5.http.impl.nio.IdentityDecoder, org.apache.hc.core5.http.impl.nio.LengthDelimitedDecoder
Imports
java.io.IOException, java.nio.channels.FileChannel
A content decoder capable of transferring data directly to a FileChannel
Since
4.0

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

The number of bytes, possibly zero, that were actually transferred
transfer(FileChannel
the target FileChannel to transfer data into.
dst, long
The position within the file at which the transfer is to begin; must be non-negative. Must be less than or equal to the size of the file
position, long
The maximum number of bytes to be transferred; must be non-negative
count)

Transfers a portion of entity content from the underlying network channel into the given file channel.

Inherited from org.apache.hc.core5.http.nio.ContentDecoder:
getTrailersisCompletedread

Method Detail

transferback to summary
public long transfer(FileChannel dst, long position, long count) throws IOException

Transfers a portion of entity content from the underlying network channel into the given file channel.

Warning

Many implementations cannot write beyond the length of the file. If the position exceeds the channel's size, some implementations may throw an IOException.

Parameters
dst:FileChannel

the target FileChannel to transfer data into.

position:long

The position within the file at which the transfer is to begin; must be non-negative. Must be less than or equal to the size of the file

count:long

The maximum number of bytes to be transferred; must be non-negative

Returns:long

The number of bytes, possibly zero, that were actually transferred

Exceptions
IOException:
if some I/O error occurs.