io.cdap.http

Class BodyProducer

java.lang.Object

io.cdap.http.BodyProducer

public abstract class BodyProducer
extends Object

Class for producing response body in streaming fashion.

Constructor Summary

Constructors

Constructor and Description
BodyProducer()

Method Summary

Modifier and Type	Method and Description
abstract void	finished() This method will get called after the last chunk of the body get sent successfully.
long	getContentLength() Returns the size of the content in bytes that this producer is going to produce.
abstract void	handleError(Throwable cause) This method will get called if there is any error raised when sending body chunks.
abstract io.netty.buffer.ByteBuf	nextChunk() Returns a ByteBuf representing the next chunk of bytes to send.

Methods inherited from class java.lang.Object

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

Constructor Detail

BodyProducer

public BodyProducer()

Method Detail

getContentLength

public long getContentLength()

Returns the size of the content in bytes that this producer is going to produce.

If a negative number is returned, the size is unknown and the Content-Length header won't be set and Transfer-Encoding: chunked will be used.

By default, -1L is returned.

Returns:

the size of the content in bytes

nextChunk

public abstract io.netty.buffer.ByteBuf nextChunk()
                                           throws Exception

Returns a ByteBuf representing the next chunk of bytes to send. If the returned ByteBuf is an empty buffer, it signals the end of the streaming.

Returns:

the next chunk of bytes to send

Throws:

Exception - if there is any error

finished

public abstract void finished()
                       throws Exception

This method will get called after the last chunk of the body get sent successfully.

Throws:

Exception - if there is any error

handleError

public abstract void handleError(@Nullable
                                 Throwable cause)

This method will get called if there is any error raised when sending body chunks. This method will also get called if there is exception raised from the nextChunk() or finished() method.

Parameters:

cause - the reason of the failure or null if the reason of failure is unknown.