Class ReactiveDataProducer

java.lang.Object

org.apache.hc.core5.reactive.ReactiveDataProducer

All Implemented Interfaces:

AsyncDataProducer, ResourceHolder, org.reactivestreams.Subscriber<ByteBuffer>

@Contract(threading=SAFE)
final class ReactiveDataProducer
extends Object
implements AsyncDataProducer, org.reactivestreams.Subscriber<ByteBuffer>

An asynchronous data producer that supports Reactive Streams.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	BUFFER_WINDOW_SIZE
private final ArrayDeque<ByteBuffer>	buffers
private final AtomicBoolean	complete
private final AtomicReference<Throwable>	exception
private final ReentrantLock	lock
private final org.reactivestreams.Publisher<ByteBuffer>	publisher
private final AtomicReference<DataStreamChannel>	requestChannel
private final AtomicReference<org.reactivestreams.Subscription>	subscription

Constructor Summary

Constructors

Constructor	Description
ReactiveDataProducer(org.reactivestreams.Publisher<ByteBuffer> publisher)

Method Summary

Modifier and Type	Method	Description
int	available()	Returns the number of bytes immediately available for output.
void	onComplete()
void	onError(Throwable throwable)
void	onNext(ByteBuffer byteBuffer)
void	onSubscribe(org.reactivestreams.Subscription subscription)
void	produce(DataStreamChannel channel)	Triggered to signal the ability of the underlying data channel to accept more data.
void	releaseResources()
(package private) void	setChannel(DataStreamChannel channel)
private void	signalReadiness()

Methods inherited from class Object

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

Field Details

BUFFER_WINDOW_SIZE

private static final int BUFFER_WINDOW_SIZE

See Also:

• Constant Field Values

requestChannel

private final AtomicReference<DataStreamChannel> requestChannel

exception

private final AtomicReference<Throwable> exception

complete

private final AtomicBoolean complete

publisher

private final org.reactivestreams.Publisher<ByteBuffer> publisher

subscription

private final AtomicReference<org.reactivestreams.Subscription> subscription

buffers

private final ArrayDeque<ByteBuffer> buffers

lock

private final ReentrantLock lock

Constructor Details

ReactiveDataProducer

public ReactiveDataProducer(org.reactivestreams.Publisher<ByteBuffer> publisher)

Method Details

setChannel

void setChannel(DataStreamChannel channel)

onSubscribe

public void onSubscribe(org.reactivestreams.Subscription subscription)

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<ByteBuffer>

onNext

public void onNext(ByteBuffer byteBuffer)

Specified by:

onNext in interface org.reactivestreams.Subscriber<ByteBuffer>

onError

public void onError(Throwable throwable)

Specified by:

onError in interface org.reactivestreams.Subscriber<ByteBuffer>

onComplete

public void onComplete()

Specified by:

onComplete in interface org.reactivestreams.Subscriber<ByteBuffer>

signalReadiness

private void signalReadiness()

available

public int available()

Description copied from interface: AsyncDataProducer

Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.

Please note this method should return zero if the data producer is unable to produce any more data, in which case AsyncDataProducer.produce(DataStreamChannel) method will not get triggered. The producer can resume writing out data asynchronously once more data becomes available or request output readiness events with DataStreamChannel.requestOutput().

Specified by:

available in interface AsyncDataProducer

Returns:

the number of bytes immediately available for output

See Also:

• AsyncDataProducer.produce(DataStreamChannel)
• DataStreamChannel.requestOutput()

produce

public void produce(DataStreamChannel channel)
             throws IOException

Description copied from interface: AsyncDataProducer

Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.

Please note this method gets triggered only if AsyncDataProducer.available() returns a positive value.

Specified by:

produce in interface AsyncDataProducer

Parameters:

channel - the data channel capable of accepting more data.

Throws:

IOException - in case of an I/O error.

See Also:

• AsyncDataProducer.available()

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface ResourceHolder