Package io.helidon.webserver

Class ResponseChunk

java.lang.Object

io.helidon.webserver.ResponseChunk

public final class ResponseChunk
extends java.lang.Object

Represents a single chunk of response data.

Data are represented as a readable ByteBuffer. The ByteBuffer can be reused when release() method is called.

Each chunk can request to be flushed or not.

Constructor Summary

Constructors

Constructor	Description
ResponseChunk(boolean flush, java.nio.ByteBuffer data)	Creates new instance.
ResponseChunk(boolean flush, java.nio.ByteBuffer data, java.lang.Runnable releaseCallback)	Creates new instance.

Method Summary

Modifier and Type	Method	Description
java.nio.ByteBuffer	data()	Returns a data.
boolean	flush()	Returns true if all caches are requested to flush when this chunk is written.
void	release()	Call when data were consumed and data buffer can be reused.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseChunk

public ResponseChunk(boolean flush,
                     java.nio.ByteBuffer data,
                     java.lang.Runnable releaseCallback)

Creates new instance.

Parameters:

flush - a signal that chunk should be written and flushed from any cache if possible

data - a data chunk. Should not be reused until releaseCallback is used

releaseCallback - a callback which is called when this chunk is completely processed and instance is free for reuse

ResponseChunk

public ResponseChunk(boolean flush,
                     java.nio.ByteBuffer data)

Creates new instance.

Parameters:

flush - a signal that chunk should be written and flushed from any cache if possible

data - a data chunk. Should not be reused until releaseCallback is used

Method Detail

release

public void release()

Call when data were consumed and data buffer can be reused.

data

public java.nio.ByteBuffer data()

Returns a data.

Returns:

a data.

flush

public boolean flush()

Returns true if all caches are requested to flush when this chunk is written.

Returns:

true if it is requested to flush all caches after this chunk