org.mule.service.http.impl.service.client

Class NonBlockingStreamWriter

java.lang.Object

org.mule.service.http.impl.service.client.NonBlockingStreamWriter

All Implemented Interfaces:

Runnable

public class NonBlockingStreamWriter
extends Object
implements Runnable

Writes the data passed via the non-blocking method addDataToWrite(OutputStream, byte[], Supplier) to the specified stream, only if there is available space. If no space available, it saves a task to try later. When it tried to execute all the pending writes, and it couldn't, then it sleeps a certain period passed via constructor (default is DEFAULT_TIME_TO_SLEEP_WHEN_COULD_NOT_WRITE_MILLIS). This is done to avoid an unnecessarily high CPU consumption.

Constructor Summary

Constructors

Constructor and Description
NonBlockingStreamWriter()
NonBlockingStreamWriter(int timeToSleepWhenCouldNotWriteMillis, boolean isEnabled)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addDataToWrite(OutputStream destinationStream, byte[] dataToWrite, Supplier<Integer> availableSpace) Tries to write from dataToWrite to destinationStream, as many bytes as the availableSpace supplier says it's possible to write.
boolean	isEnabled()
void	notifyAvailableSpace() Wake up the writer thread to avoid sleeping too much and cause degradations.
void	run()
void	stop() Signals the writer to stop writing.

Methods inherited from class java.lang.Object

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

Constructor Detail

NonBlockingStreamWriter

public NonBlockingStreamWriter(int timeToSleepWhenCouldNotWriteMillis,
                               boolean isEnabled)

NonBlockingStreamWriter

public NonBlockingStreamWriter()

Method Detail

isEnabled

public boolean isEnabled()

addDataToWrite

public CompletableFuture<Void> addDataToWrite(OutputStream destinationStream,
                                              byte[] dataToWrite,
                                              Supplier<Integer> availableSpace)

Tries to write from dataToWrite to destinationStream, as many bytes as the availableSpace supplier says it's possible to write. If the supplier returns 0, it schedules a task to try later.

Parameters:

destinationStream - where the data has to be written.

dataToWrite - the data to write.

availableSpace - a supplier that says how many bytes can be written to the stream without blocking.

Returns:

a CompletableFuture that will be completed when all the data was written, or when an exception occurs.

run

public void run()

Specified by:

run in interface Runnable

notifyAvailableSpace

public void notifyAvailableSpace()

Wake up the writer thread to avoid sleeping too much and cause degradations.

stop

public void stop()

Signals the writer to stop writing. It can also be stopped by interrupting the thread where it's running.