public abstract class DataBufferUtils
extends java.lang.Object
DataBuffers
.Modifier and Type | Class and Description |
---|---|
private static class |
DataBufferUtils.ReadableByteChannelGenerator |
private static class |
DataBufferUtils.ReadCompletionHandler |
private static class |
DataBufferUtils.WritableByteChannelSubscriber |
private static class |
DataBufferUtils.WriteCompletionHandler |
Modifier and Type | Field and Description |
---|---|
private static DataBufferFactory |
defaultDataBufferFactory
Workaround to disable use of pooled buffers:
https://github.com/reactor/reactor-core/issues/1634.
|
private static java.util.function.Consumer<DataBuffer> |
RELEASE_CONSUMER |
Constructor and Description |
---|
DataBufferUtils() |
Modifier and Type | Method and Description |
---|---|
(package private) static void |
closeChannel(java.nio.channels.Channel channel) |
static <any> |
join(<any> dataBuffers)
Return a new
DataBuffer composed from joining together the given
dataBuffers elements. |
static <any> |
read(Resource resource,
DataBufferFactory bufferFactory,
int bufferSize)
Read the given
Resource into a Flux of DataBuffer s. |
static <any> |
read(Resource resource,
long position,
DataBufferFactory bufferFactory,
int bufferSize)
Read the given
Resource into a Flux of DataBuffer s
starting at the given position. |
static <any> |
readAsynchronousFileChannel(java.util.concurrent.Callable<java.nio.channels.AsynchronousFileChannel> channelSupplier,
DataBufferFactory bufferFactory,
int bufferSize)
Obtain a
AsynchronousFileChannel from the given supplier, and read
it into a Flux of DataBuffer s. |
static <any> |
readAsynchronousFileChannel(java.util.concurrent.Callable<java.nio.channels.AsynchronousFileChannel> channelSupplier,
long position,
DataBufferFactory bufferFactory,
int bufferSize)
Obtain a
AsynchronousFileChannel from the given supplier, and
read it into a Flux of DataBuffer s, starting at the given
position. |
static <any> |
readByteChannel(java.util.concurrent.Callable<java.nio.channels.ReadableByteChannel> channelSupplier,
DataBufferFactory bufferFactory,
int bufferSize)
Obtain a
ReadableByteChannel from the given supplier, and read
it into a Flux of DataBuffer s. |
static <any> |
readInputStream(java.util.concurrent.Callable<java.io.InputStream> inputStreamSupplier,
DataBufferFactory bufferFactory,
int bufferSize)
Obtain a
InputStream from the given supplier, and read it into a
Flux of DataBuffer s. |
static boolean |
release(DataBuffer dataBuffer)
Release the given data buffer, if it is a
PooledDataBuffer and
has been allocated. |
static java.util.function.Consumer<DataBuffer> |
releaseConsumer()
Return a consumer that calls
release(DataBuffer) on all
passed data buffers. |
static <T extends DataBuffer> |
retain(T dataBuffer)
Retain the given data buffer, it it is a
PooledDataBuffer . |
static <any> |
skipUntilByteCount(<any> publisher,
long maxByteCount)
Skip buffers from the given
Publisher until the total
byte count reaches
the given maximum byte count, or until the publisher is complete. |
static <any> |
takeUntilByteCount(<any> publisher,
long maxByteCount)
Relay buffers from the given
Publisher until the total
byte count reaches
the given maximum byte count, or until the publisher is complete. |
static <any> |
write(<any> source,
java.nio.channels.AsynchronousFileChannel channel)
Write the given stream of
DataBuffers to the given
AsynchronousFileChannel . |
static <any> |
write(<any> source,
java.nio.channels.AsynchronousFileChannel channel,
long position)
Write the given stream of
DataBuffers to the given
AsynchronousFileChannel . |
static <any> |
write(<any> source,
java.io.OutputStream outputStream)
Write the given stream of
DataBuffers to the given
OutputStream . |
static <any> |
write(<any> source,
java.nio.channels.WritableByteChannel channel)
Write the given stream of
DataBuffers to the given
WritableByteChannel . |
private static final java.util.function.Consumer<DataBuffer> RELEASE_CONSUMER
private static final DataBufferFactory defaultDataBufferFactory
public static <any> readInputStream(java.util.concurrent.Callable<java.io.InputStream> inputStreamSupplier, DataBufferFactory bufferFactory, int bufferSize)
InputStream
from the given supplier, and read it into a
Flux
of DataBuffer
s. Closes the input stream when the
Flux is terminated.inputStreamSupplier
- the supplier for the input stream to read frombufferFactory
- the factory to create data buffers withbufferSize
- the maximum size of the data bufferspublic static <any> readByteChannel(java.util.concurrent.Callable<java.nio.channels.ReadableByteChannel> channelSupplier, DataBufferFactory bufferFactory, int bufferSize)
ReadableByteChannel
from the given supplier, and read
it into a Flux
of DataBuffer
s. Closes the channel when
the Flux is terminated.channelSupplier
- the supplier for the channel to read frombufferFactory
- the factory to create data buffers withbufferSize
- the maximum size of the data bufferspublic static <any> readAsynchronousFileChannel(java.util.concurrent.Callable<java.nio.channels.AsynchronousFileChannel> channelSupplier, DataBufferFactory bufferFactory, int bufferSize)
AsynchronousFileChannel
from the given supplier, and read
it into a Flux
of DataBuffer
s. Closes the channel when
the Flux is terminated.channelSupplier
- the supplier for the channel to read frombufferFactory
- the factory to create data buffers withbufferSize
- the maximum size of the data bufferspublic static <any> readAsynchronousFileChannel(java.util.concurrent.Callable<java.nio.channels.AsynchronousFileChannel> channelSupplier, long position, DataBufferFactory bufferFactory, int bufferSize)
AsynchronousFileChannel
from the given supplier, and
read it into a Flux
of DataBuffer
s, starting at the given
position. Closes the channel when the Flux is terminated.channelSupplier
- the supplier for the channel to read fromposition
- the position to start reading frombufferFactory
- the factory to create data buffers withbufferSize
- the maximum size of the data bufferspublic static <any> read(Resource resource, DataBufferFactory bufferFactory, int bufferSize)
Resource
into a Flux
of DataBuffer
s.
If the resource is a file, it is read into an
AsynchronousFileChannel
and turned to Flux
via
readAsynchronousFileChannel(Callable, DataBufferFactory, int)
or else
fall back to readByteChannel(Callable, DataBufferFactory, int)
.
Closes the channel when the flux is terminated.
resource
- the resource to read frombufferFactory
- the factory to create data buffers withbufferSize
- the maximum size of the data bufferspublic static <any> read(Resource resource, long position, DataBufferFactory bufferFactory, int bufferSize)
Resource
into a Flux
of DataBuffer
s
starting at the given position.
If the resource is a file, it is read into an
AsynchronousFileChannel
and turned to Flux
via
readAsynchronousFileChannel(Callable, DataBufferFactory, int)
or else
fall back on readByteChannel(Callable, DataBufferFactory, int)
.
Closes the channel when the flux is terminated.
resource
- the resource to read fromposition
- the position to start reading frombufferFactory
- the factory to create data buffers withbufferSize
- the maximum size of the data bufferspublic static <any> write(<any> source, java.io.OutputStream outputStream)
DataBuffers
to the given
OutputStream
. Does not close the output stream
when the flux is terminated, and does not
release the data buffers in the source.
If releasing is required, then subscribe to the returned Flux
with a releaseConsumer()
.
Note that the writing process does not start until the returned
Flux
is subscribed to.
source
- the stream of data buffers to be writtenoutputStream
- the output stream to write tosource
, that
starts the writing process when subscribed to, and that publishes any
writing errors and the completion signalpublic static <any> write(<any> source, java.nio.channels.WritableByteChannel channel)
DataBuffers
to the given
WritableByteChannel
. Does not close the channel
when the flux is terminated, and does not
release the data buffers in the source.
If releasing is required, then subscribe to the returned Flux
with a releaseConsumer()
.
Note that the writing process does not start until the returned
Flux
is subscribed to.
source
- the stream of data buffers to be writtenchannel
- the channel to write tosource
, that
starts the writing process when subscribed to, and that publishes any
writing errors and the completion signalpublic static <any> write(<any> source, java.nio.channels.AsynchronousFileChannel channel)
DataBuffers
to the given
AsynchronousFileChannel
. Does not close the
channel when the flux is terminated, and does not
release the data buffers in the source.
If releasing is required, then subscribe to the returned Flux
with a releaseConsumer()
.
Note that the writing process does not start until the returned
Flux
is subscribed to.
source
- the stream of data buffers to be writtenchannel
- the channel to write tosource
, that
starts the writing process when subscribed to, and that publishes any
writing errors and the completion signalpublic static <any> write(<any> source, java.nio.channels.AsynchronousFileChannel channel, long position)
DataBuffers
to the given
AsynchronousFileChannel
. Does not close the channel
when the flux is terminated, and does not
release the data buffers in the source.
If releasing is required, then subscribe to the returned Flux
with a
releaseConsumer()
.
Note that the writing process does not start until the returned
Flux
is subscribed to.
source
- the stream of data buffers to be writtenchannel
- the channel to write toposition
- file position write write is to begin; must be non-negativesource
, that
starts the writing process when subscribed to, and that publishes any
writing errors and the completion signalstatic void closeChannel(@Nullable java.nio.channels.Channel channel)
public static <any> takeUntilByteCount(<any> publisher, long maxByteCount)
Publisher
until the total
byte count reaches
the given maximum byte count, or until the publisher is complete.publisher
- the publisher to filtermaxByteCount
- the maximum byte countmaxByteCount
public static <any> skipUntilByteCount(<any> publisher, long maxByteCount)
Publisher
until the total
byte count reaches
the given maximum byte count, or until the publisher is complete.publisher
- the publisher to filtermaxByteCount
- the maximum byte countpublic static <T extends DataBuffer> T retain(T dataBuffer)
PooledDataBuffer
.dataBuffer
- the data buffer to retainpublic static boolean release(@Nullable DataBuffer dataBuffer)
PooledDataBuffer
and
has been allocated.dataBuffer
- the data buffer to releasetrue
if the buffer was released; false
otherwise.public static java.util.function.Consumer<DataBuffer> releaseConsumer()
release(DataBuffer)
on all
passed data buffers.public static <any> join(<any> dataBuffers)
DataBuffer
composed from joining together the given
dataBuffers
elements. Depending on the DataBuffer
type,
the returned buffer may be a single buffer containing all data of the
provided buffers, or it may be a zero-copy, composite with references to
the given buffers.
If dataBuffers
produces an error or if there is a cancel
signal, then all accumulated buffers will be
released.
Note that the given data buffers do not have to be released. They will be released as part of the returned composite.
dataBuffers
- the data buffers that are to be composeddataBuffers
argument