public class

IdentityDecoder

extends AbstractContentDecoder
implements FileContentDecoder
java.lang.Object
   ↳ org.apache.http.impl.nio.codecs.AbstractContentDecoder
     ↳ org.apache.http.impl.nio.codecs.IdentityDecoder

Class Overview

Content decoder that reads data without any transformation. The end of the content entity is demarcated by closing the underlying connection (EOF condition). Entities transferred using this input stream can be of unlimited length.

This decoder is optimized to transfer data directly from the underlying I/O session's channel to a FileChannel, whenever possible avoiding intermediate buffering in the session buffer.

Summary

[Expand]
Inherited Fields
From class org.apache.http.impl.nio.codecs.AbstractContentDecoder
Public Constructors
IdentityDecoder(ReadableByteChannel channel, SessionInputBuffer buffer, HttpTransportMetricsImpl metrics)
Public Methods
int read(ByteBuffer dst)
Reads a portion of content from the underlying channel
void setCompleted(boolean completed)
Sets the completed status of this decoder.
String toString()
long transfer(FileChannel dst, long position, long count)
Transfers a portion of entity content from the underlying network channel into the given file channel.
[Expand]
Inherited Methods
From class org.apache.http.impl.nio.codecs.AbstractContentDecoder
From class java.lang.Object
From interface org.apache.http.nio.ContentDecoder
From interface org.apache.http.nio.FileContentDecoder

Public Constructors

public IdentityDecoder (ReadableByteChannel channel, SessionInputBuffer buffer, HttpTransportMetricsImpl metrics)

Public Methods

public int read (ByteBuffer dst)

Reads a portion of content from the underlying channel

Parameters
dst The buffer into which entity content is to be transferred
Returns
  • The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream
Throws
IOException

public void setCompleted (boolean completed)

Sets the completed status of this decoder. Normally this is not necessary (the decoder will automatically complete when the underlying channel returns EOF). It is useful to mark the decoder as completed if you have some other means to know all the necessary data has been read and want to reuse the underlying connection for more messages.

public String toString ()

public long transfer (FileChannel dst, long position, long count)

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 the target FileChannel to transfer data into.
position 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 The maximum number of bytes to be transferred; must be non-negative
Returns
  • The number of bytes, possibly zero, that were actually transferred
Throws
IOException