Package io.micronaut.http.body

Class AbstractBodyAdapter

java.lang.Object

io.micronaut.http.body.AbstractBodyAdapter

All Implemented Interfaces:

BufferConsumer.Upstream, Subscriber<ReadBuffer>

@Internal
public class AbstractBodyAdapter
extends Object
implements BufferConsumer.Upstream, Subscriber<ReadBuffer>

An adapter that transforms a Publisher of buffers to a ByteBody. Called AbstractBodyAdapter for historical reasons, but can be used as-is.

Since:

4.8.0

Author:

Jonas Konrad

Constructor Summary

Constructors

Constructor	Description
AbstractBodyAdapter(@NonNull Publisher<ReadBuffer> source, @Nullable Runnable onDiscard)

Method Summary

Modifier and Type	Method	Description
final void	allowDiscard()	Allow the upstream to discard any further messages.
final void	disregardBackpressure()	Instruct the upstream to ignore backpressure from this consumer.
final void	onBytesConsumed(long bytesConsumed)	Called when a number of bytes has been consumed by the downstream.
void	onComplete()
void	onError(Throwable t)
void	onNext(ReadBuffer buffer)
final void	onSubscribe(Subscription s)
final void	setSharedBuffer(BaseSharedBuffer sharedBuffer)
final void	start()	Signal that we want to start consuming bytes.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBodyAdapter

public AbstractBodyAdapter(@NonNull
 @NonNull Publisher<ReadBuffer> source,
 @Nullable
 @Nullable Runnable onDiscard)

Method Details

setSharedBuffer

public final void setSharedBuffer(BaseSharedBuffer sharedBuffer)

start

public final void start()

Description copied from interface: BufferConsumer.Upstream

Signal that we want to start consuming bytes. This is an optional hint to the upstream, the upstream may ignore it and send bytes immediately. This is used for CONTINUE support.

Specified by:

start in interface BufferConsumer.Upstream

onBytesConsumed

public final void onBytesConsumed(long bytesConsumed)

Description copied from interface: BufferConsumer.Upstream

Called when a number of bytes has been consumed by the downstream. Note that this can exceed the actual number of bytes written so far, if the downstream wants to signal it is ready consume much more data.

Specified by:

onBytesConsumed in interface BufferConsumer.Upstream

Parameters:

bytesConsumed - The number of bytes that were consumed

allowDiscard

public final void allowDiscard()

Description copied from interface: BufferConsumer.Upstream

Allow the upstream to discard any further messages. Note that this does not actually mean the messages must be discarded: If another consumer still needs the body data, it may continue to be read and continue to be forwarded to this consumer.

Specified by:

allowDiscard in interface BufferConsumer.Upstream

disregardBackpressure

public final void disregardBackpressure()

Description copied from interface: BufferConsumer.Upstream

Instruct the upstream to ignore backpressure from this consumer. This is slightly different from onBytesConsumed(Long.MAX_VALUE): If there are two consumers in ByteBody.SplitBackpressureMode.FASTEST mode, a MAX_VALUE requests all data from the common upstream, while a disregardBackpressure removes this downstream from consideration.

Specified by:

disregardBackpressure in interface BufferConsumer.Upstream

onSubscribe

public final void onSubscribe(Subscription s)

Specified by:

onSubscribe in interface Subscriber<ReadBuffer>

onNext

public void onNext(ReadBuffer buffer)

Specified by:

onNext in interface Subscriber<ReadBuffer>

onError

public void onError(Throwable t)

Specified by:

onError in interface Subscriber<ReadBuffer>

onComplete

public void onComplete()

Specified by:

onComplete in interface Subscriber<ReadBuffer>