org.asynchttpclient

Class HttpResponseBodyPart

java.lang.Object

org.asynchttpclient.HttpResponseBodyPart

Direct Known Subclasses:

NettyResponseBodyPart

public abstract class HttpResponseBodyPart
extends Object

A callback class used when an HTTP response body is received.

Constructor Summary

Constructors

Constructor and Description
HttpResponseBodyPart()

Method Summary

Modifier and Type	Method and Description
abstract ByteBuffer	getBodyByteBuffer() Return a ByteBuffer that wraps the actual bytes read from the response's chunk.
abstract byte[]	getBodyPartBytes() Return the response body's part bytes received.
abstract boolean	isLast() Return true if this is the last part.
abstract boolean	isUnderlyingConnectionToBeClosed() Return true of the underlying connection will be closed once the response has been fully processed.
abstract int	length() Return length of this part in bytes.
abstract void	markUnderlyingConnectionAsToBeClosed() Close the underlying connection once the processing has completed.
abstract InputStream	readBodyPartBytes() Method for accessing contents of this part via stream.
abstract int	writeTo(OutputStream outputStream) Write the available bytes to the OutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponseBodyPart

public HttpResponseBodyPart()

Method Detail

length

public abstract int length()

Return length of this part in bytes.

Since:

2.0.0

getBodyPartBytes

public abstract byte[] getBodyPartBytes()

Return the response body's part bytes received.

Returns:

the response body's part bytes received.

readBodyPartBytes

public abstract InputStream readBodyPartBytes()

Method for accessing contents of this part via stream.

Since:

2.0.0

writeTo

public abstract int writeTo(OutputStream outputStream)
                     throws IOException

Write the available bytes to the OutputStream

Parameters:

outputStream -

Returns:

The number of bytes written

Throws:

IOException

getBodyByteBuffer

public abstract ByteBuffer getBodyByteBuffer()

Return a ByteBuffer that wraps the actual bytes read from the response's chunk. The ByteBuffer capacity is equal to the number of bytes available.

Returns:

ByteBuffer

isLast

public abstract boolean isLast()

Return true if this is the last part.

Returns:

true if this is the last part.

markUnderlyingConnectionAsToBeClosed

public abstract void markUnderlyingConnectionAsToBeClosed()

Close the underlying connection once the processing has completed. Invoking that method means the underlying TCP connection will be closed as soon as the processing of the response is completed. That means the underlying connection will never get pooled.

isUnderlyingConnectionToBeClosed

public abstract boolean isUnderlyingConnectionToBeClosed()

Return true of the underlying connection will be closed once the response has been fully processed.

Returns:

true of the underlying connection will be closed once the response has been fully processed.