Class StreamingNettyByteBody

java.lang.Object

io.micronaut.http.body.InternalByteBody

io.micronaut.http.body.stream.BaseStreamingByteBody<StreamingNettyByteBody.SharedBuffer>

io.micronaut.http.netty.body.StreamingNettyByteBody

All Implemented Interfaces:

ByteBody, CloseableByteBody, Closeable, AutoCloseable

@Internal
public final class StreamingNettyByteBody
extends BaseStreamingByteBody<StreamingNettyByteBody.SharedBuffer>
implements CloseableByteBody

Netty implementation for streaming ByteBody.

Since:

4.5.0

Author:

Jonas Konrad

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StreamingNettyByteBody.SharedBuffer	This class buffers input data and distributes it to multiple StreamingNettyByteBody instances.

Nested classes/interfaces inherited from interface ByteBody

ByteBody.BodyDiscardedException, ByteBody.SplitBackpressureMode

Field Summary

Fields inherited from class BaseStreamingByteBody

sharedBuffer, upstream

Constructor Summary

Constructors

Constructor	Description
StreamingNettyByteBody(StreamingNettyByteBody.SharedBuffer sharedBuffer)

Method Summary

Modifier and Type	Method	Description
ExecutionFlow<? extends CloseableAvailableByteBody>	bufferFlow()	Variant of InternalByteBody.buffer() that uses the ExecutionFlow API for extra efficiency.
void	close()	Clean up any resources held by this instance.
protected BaseStreamingByteBody<StreamingNettyByteBody.SharedBuffer>	derive(BufferConsumer.Upstream upstream)	Create a new body instance on the same shared buffer with the given upstream.
BufferConsumer.Upstream	primary(@Nullable BufferConsumer primary)	Consume this buffer.
CloseableByteBody	split(ByteBody.SplitBackpressureMode backpressureMode)	Create a new, independent ByteBody that contains the same data as this one.
void	touch()	Debug trace for leak detection.

Methods inherited from class BaseStreamingByteBody

allowDiscard, expectedLength, move, toInputStream, toReadBufferPublisher

Methods inherited from class InternalByteBody

buffer, bufferFlow, failClaim, recordClosed, recordPrimaryOp, toByteArrayPublisher

Methods inherited from class Object

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

Methods inherited from interface ByteBody

buffer, expectedLength, move, split, toByteArrayPublisher, toByteBufferPublisher, toInputStream, toReadBufferPublisher

Methods inherited from interface CloseableByteBody

allowDiscard

Constructor Details

StreamingNettyByteBody

public StreamingNettyByteBody(StreamingNettyByteBody.SharedBuffer sharedBuffer)

Method Details

primary

public BufferConsumer.Upstream primary(@Nullable BufferConsumer primary)

Description copied from class: BaseStreamingByteBody

Consume this buffer.

Specified by:

primary in class BaseStreamingByteBody<StreamingNettyByteBody.SharedBuffer>

Parameters:

primary - The consumer or null to discard the data

Returns:

The upstream to signal backpressure

derive

protected BaseStreamingByteBody<StreamingNettyByteBody.SharedBuffer> derive(BufferConsumer.Upstream upstream)

Description copied from class: BaseStreamingByteBody

Create a new body instance on the same shared buffer with the given upstream. This is used for BaseStreamingByteBody.move().

Specified by:

derive in class BaseStreamingByteBody<StreamingNettyByteBody.SharedBuffer>

Parameters:

upstream - The upstream

Returns:

The body

split

public CloseableByteBody split(ByteBody.SplitBackpressureMode backpressureMode)

Description copied from interface: ByteBody

Create a new, independent ByteBody that contains the same data as this one.

Specified by:

split in interface ByteBody

Parameters:

backpressureMode - How to handle backpressure between the old and new body. See ByteBody.SplitBackpressureMode documentation

Returns:

The newly split body. Must be closed by the caller, unless a terminal operation is performed on it

bufferFlow

public ExecutionFlow<? extends CloseableAvailableByteBody> bufferFlow()

Description copied from class: InternalByteBody

Variant of InternalByteBody.buffer() that uses the ExecutionFlow API for extra efficiency.

Specified by:

bufferFlow in class InternalByteBody

Returns:

A flow that completes when all bytes are available

close

public void close()

Description copied from interface: CloseableByteBody

Clean up any resources held by this instance. See class documentation.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface CloseableByteBody

touch

public void touch()

Description copied from interface: ByteBody

Debug trace for leak detection.

Specified by:

touch in interface ByteBody