Package io.micronaut.http.server.netty.body

Class NettyByteBody

java.lang.Object

io.micronaut.http.server.netty.body.NettyByteBody

All Implemented Interfaces:

ByteBody, InternalByteBody

Direct Known Subclasses:

AvailableNettyByteBody, StreamingNettyByteBody

@Internal
public abstract sealed class NettyByteBody
extends Object
implements ByteBody, InternalByteBody
permits AvailableNettyByteBody, StreamingNettyByteBody

Common base class for streaming and immediate netty ByteBody implementations.

Since:

4.5.0

Author:

Jonas Konrad

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.http.body.ByteBody

ByteBody.BodyDiscardedException, ByteBody.SplitBackpressureMode

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
NettyByteBody()

Method Summary

Modifier and Type	Method	Description
CompletableFuture<? extends CloseableAvailableByteBody>	buffer()	Buffer the full body and return an CompletableFuture that will complete when all bytes are available, or an error occurs.
abstract @NonNull ExecutionFlow<? extends CloseableAvailableByteBody>	bufferFlow()	Variant of ByteBody.buffer() that uses the ExecutionFlow API for extra efficiency.
@NonNull Publisher<byte[]>	toByteArrayPublisher()	Get this body as a reactive stream of byte arrays.
@NonNull Publisher<ByteBuffer<?>>	toByteBufferPublisher()	Get this body as a reactive stream of ByteBuffers.
static reactor.core.publisher.Flux<io.netty.buffer.ByteBuf>	toByteBufs(ByteBody body)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.body.ByteBody

allowDiscard, expectedLength, split, split, toInputStream

Field Details

LOG

protected static final org.slf4j.Logger LOG

Constructor Details

NettyByteBody

public NettyByteBody()

Method Details

toByteBufs

public static reactor.core.publisher.Flux<io.netty.buffer.ByteBuf> toByteBufs(ByteBody body)

toByteArrayPublisher

@NonNull
public @NonNull Publisher<byte[]> toByteArrayPublisher()

Description copied from interface: ByteBody

Get this body as a reactive stream of byte arrays.

This is a primary operation. After this operation, no other primary operation or ByteBody.split() may be done.

Specified by:

toByteArrayPublisher in interface ByteBody

Returns:

The streamed bytes

toByteBufferPublisher

@NonNull
public @NonNull Publisher<ByteBuffer<?>> toByteBufferPublisher()

Description copied from interface: ByteBody

Get this body as a reactive stream of ByteBuffers. Note that the buffers may be reference counted, and the caller must take care of releasing them.

This is a primary operation. After this operation, no other primary operation or ByteBody.split() may be done.

Specified by:

toByteBufferPublisher in interface ByteBody

Returns:

The streamed bytes

bufferFlow

@NonNull
public abstract @NonNull ExecutionFlow<? extends CloseableAvailableByteBody> bufferFlow()

Description copied from interface: InternalByteBody

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

Specified by:

bufferFlow in interface InternalByteBody

Returns:

A flow that completes when all bytes are available

buffer

public CompletableFuture<? extends CloseableAvailableByteBody> buffer()

Description copied from interface: ByteBody

Buffer the full body and return an CompletableFuture that will complete when all bytes are available, or an error occurs.

This is a primary operation. After this operation, no other primary operation or ByteBody.split() may be done.

Specified by:

buffer in interface ByteBody

Returns:

A future that completes when all bytes are available