reactor.netty

Class ByteBufFlux

java.lang.Object

reactor.core.publisher.Flux<O>

reactor.core.publisher.FluxOperator<ByteBuf,ByteBuf>

reactor.netty.ByteBufFlux

All Implemented Interfaces:

Publisher<ByteBuf>, CorePublisher<ByteBuf>, Scannable

public class ByteBufFlux
extends FluxOperator<ByteBuf,ByteBuf>

A decorating Flux NettyInbound with various ByteBuf related operations.

Author:

Stephane Maldini

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Scannable

Scannable.Attr<T>

Field Summary

Fields inherited from class reactor.core.publisher.FluxOperator

source

Fields inherited from interface reactor.core.Scannable

OPERATOR_NAME_UNRELATED_WORDS_PATTERN

Method Summary

Modifier and Type	Method and Description
ByteBufMono	aggregate() Aggregate subsequent byte buffers into a single buffer.
Flux<byte[]>	asByteArray() Convert to a byte[] inbound Flux
Flux<ByteBuffer>	asByteBuffer() Convert to a ByteBuffer inbound Flux
Flux<InputStream>	asInputStream() Convert to an InputStream inbound Flux
Flux<String>	asString() Convert to a String inbound Flux using the default Charset.
Flux<String>	asString(Charset charset) Convert to a String inbound Flux using the provided Charset.
static ByteBufFlux	fromInbound(Publisher<?> source) Decorate as ByteBufFlux
static ByteBufFlux	fromInbound(Publisher<?> source, ByteBufAllocator allocator) Decorate as ByteBufFlux
static ByteBufFlux	fromPath(Path path) Open a FileChannel from a path and stream ByteBuf chunks with a default maximum size of 500K into the returned ByteBufFlux
static ByteBufFlux	fromPath(Path path, ByteBufAllocator allocator) Open a FileChannel from a path and stream ByteBuf chunks with a default maximum size of 500K into the returned ByteBufFlux, using the provided ByteBufAllocator.
static ByteBufFlux	fromPath(Path path, int maxChunkSize) Open a FileChannel from a path and stream ByteBuf chunks with a given maximum size into the returned ByteBufFlux
static ByteBufFlux	fromPath(Path path, int maxChunkSize, ByteBufAllocator allocator) Open a FileChannel from a path and stream ByteBuf chunks with a given maximum size into the returned ByteBufFlux, using the provided ByteBufAllocator.
static ByteBufFlux	fromString(Publisher<? extends String> source) Decorate as ByteBufFlux
static ByteBufFlux	fromString(Publisher<? extends String> source, Charset charset, ByteBufAllocator allocator)
ByteBufMono	multicast() Allow multiple consumers downstream of the flux while also disabling auto memory release on each buffer published (retaining in order to prevent premature recycling).
ByteBufFlux	retain() Disable auto memory release on each buffer published, retaining in order to prevent premature recycling when buffers are accumulated downstream (async).
void	subscribe(CoreSubscriber<? super ByteBuf> s)

Methods inherited from class reactor.core.publisher.FluxOperator

scanUnsafe

Methods inherited from class reactor.core.publisher.Flux

all, any, as, blockFirst, blockFirst, blockLast, blockLast, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, bufferTimeout, bufferTimeout, bufferTimeout, bufferTimeout, bufferUntil, bufferUntil, bufferUntilChanged, bufferUntilChanged, bufferUntilChanged, bufferWhen, bufferWhen, bufferWhile, cache, cache, cache, cache, cache, cache, cancelOn, cast, checkpoint, checkpoint, checkpoint, collect, collect, collectList, collectMap, collectMap, collectMap, collectMultimap, collectMultimap, collectMultimap, collectSortedList, collectSortedList, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, compose, concat, concat, concat, concat, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatMap, concatMap, concatMapDelayError, concatMapDelayError, concatMapDelayError, concatMapIterable, concatMapIterable, concatWith, concatWithValues, count, create, create, defaultIfEmpty, defer, deferWithContext, delayElements, delayElements, delaySequence, delaySequence, delaySubscription, delaySubscription, delaySubscription, delayUntil, dematerialize, distinct, distinct, distinct, distinct, distinctUntilChanged, distinctUntilChanged, distinctUntilChanged, doAfterTerminate, doFinally, doFirst, doOnCancel, doOnComplete, doOnDiscard, doOnEach, doOnError, doOnError, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, elapsed, elapsed, elementAt, elementAt, empty, error, error, error, expand, expand, expandDeep, expandDeep, filter, filterWhen, filterWhen, first, first, flatMap, flatMap, flatMap, flatMap, flatMapDelayError, flatMapIterable, flatMapIterable, flatMapSequential, flatMapSequential, flatMapSequential, flatMapSequentialDelayError, from, fromArray, fromIterable, fromStream, fromStream, generate, generate, generate, getPrefetch, groupBy, groupBy, groupBy, groupBy, groupJoin, handle, hasElement, hasElements, hide, ignoreElements, index, index, interval, interval, interval, interval, join, just, just, last, last, limitRate, limitRate, limitRequest, log, log, log, log, log, log, map, materialize, merge, merge, merge, merge, merge, merge, mergeDelayError, mergeOrdered, mergeOrdered, mergeOrdered, mergeOrderedWith, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequentialDelayError, mergeSequentialDelayError, mergeSequentialDelayError, mergeWith, metrics, name, never, next, ofType, onAssembly, onAssembly, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureError, onBackpressureLatest, onErrorContinue, onErrorContinue, onErrorContinue, onErrorMap, onErrorMap, onErrorMap, onErrorResume, onErrorResume, onErrorResume, onErrorReturn, onErrorReturn, onErrorReturn, onErrorStop, onLastAssembly, onTerminateDetach, or, parallel, parallel, parallel, publish, publish, publish, publish, publishNext, publishOn, publishOn, publishOn, push, push, range, reduce, reduce, reduceWith, repeat, repeat, repeat, repeat, repeatWhen, replay, replay, replay, replay, replay, replay, retry, retry, retry, retry, retryBackoff, retryBackoff, retryBackoff, retryBackoff, retryBackoff, retryWhen, retryWhen, sample, sample, sampleFirst, sampleFirst, sampleTimeout, sampleTimeout, scan, scan, scanWith, share, single, single, singleOrEmpty, skip, skip, skip, skipLast, skipUntil, skipUntilOther, skipWhile, sort, sort, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeOn, subscriberContext, subscriberContext, subscribeWith, switchIfEmpty, switchMap, switchMap, switchOnFirst, switchOnFirst, switchOnNext, switchOnNext, tag, take, take, take, takeLast, takeUntil, takeUntilOther, takeWhile, then, then, thenEmpty, thenMany, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timestamp, timestamp, toIterable, toIterable, toIterable, toStream, toStream, toString, transform, transformDeferred, using, using, usingWhen, usingWhen, usingWhen, usingWhen, window, window, window, window, window, window, window, windowTimeout, windowTimeout, windowUntil, windowUntil, windowUntil, windowUntilChanged, windowUntilChanged, windowUntilChanged, windowWhen, windowWhile, windowWhile, withLatestFrom, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipWith, zipWith, zipWith, zipWith, zipWithIterable, zipWithIterable

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.Scannable

actuals, from, inners, isScanAvailable, name, parents, scan, scanOrDefault, stepName, steps, tags

Method Detail

fromInbound

public static ByteBufFlux fromInbound(Publisher<?> source)

Decorate as ByteBufFlux

Parameters:

source - publisher to decorate

Returns:

a ByteBufFlux

fromInbound

public static ByteBufFlux fromInbound(Publisher<?> source,
                                      ByteBufAllocator allocator)

Decorate as ByteBufFlux

Parameters:

source - publisher to decorate

allocator - the channel ByteBufAllocator

Returns:

a ByteBufFlux

fromString

public static ByteBufFlux fromString(Publisher<? extends String> source)

Decorate as ByteBufFlux

Parameters:

source - publisher to decorate

Returns:

a ByteBufFlux

fromString

public static ByteBufFlux fromString(Publisher<? extends String> source,
                                     Charset charset,
                                     ByteBufAllocator allocator)

fromPath

public static ByteBufFlux fromPath(Path path)

Open a FileChannel from a path and stream ByteBuf chunks with a default maximum size of 500K into the returned ByteBufFlux

Parameters:

path - the path to the resource to stream

Returns:

a ByteBufFlux

fromPath

public static ByteBufFlux fromPath(Path path,
                                   int maxChunkSize)

Open a FileChannel from a path and stream ByteBuf chunks with a given maximum size into the returned ByteBufFlux

Parameters:

path - the path to the resource to stream

maxChunkSize - the maximum per-item ByteBuf size

Returns:

a ByteBufFlux

fromPath

public static ByteBufFlux fromPath(Path path,
                                   ByteBufAllocator allocator)

Open a FileChannel from a path and stream ByteBuf chunks with a default maximum size of 500K into the returned ByteBufFlux, using the provided ByteBufAllocator.

Parameters:

path - the path to the resource to stream

allocator - the channel ByteBufAllocator

Returns:

a ByteBufFlux

fromPath

public static ByteBufFlux fromPath(Path path,
                                   int maxChunkSize,
                                   ByteBufAllocator allocator)

Open a FileChannel from a path and stream ByteBuf chunks with a given maximum size into the returned ByteBufFlux, using the provided ByteBufAllocator.

Parameters:

path - the path to the resource to stream

maxChunkSize - the maximum per-item ByteBuf size

allocator - the channel ByteBufAllocator

Returns:

a ByteBufFlux

asByteBuffer

public final Flux<ByteBuffer> asByteBuffer()

Convert to a ByteBuffer inbound Flux

Returns:

a ByteBuffer inbound Flux

asByteArray

public final Flux<byte[]> asByteArray()

Convert to a byte[] inbound Flux

Returns:

a byte[] inbound Flux

asInputStream

public final Flux<InputStream> asInputStream()

Convert to an InputStream inbound Flux

Note: Auto memory release is disabled. The underlying ByteBuf will be released only when InputStream.close() is invoked. Ensure InputStream.close() is invoked for any terminal signal: complete | error | cancel

Returns:

a InputStream inbound Flux

asString

public final Flux<String> asString()

Convert to a String inbound Flux using the default Charset.

Returns:

a String inbound Flux

asString

public final Flux<String> asString(Charset charset)

Convert to a String inbound Flux using the provided Charset.

Parameters:

charset - the decoding charset

Returns:

a String inbound Flux

aggregate

public final ByteBufMono aggregate()

Aggregate subsequent byte buffers into a single buffer.

Returns:

ByteBufMono of aggregated ByteBuf

multicast

public final ByteBufMono multicast()

Allow multiple consumers downstream of the flux while also disabling auto memory release on each buffer published (retaining in order to prevent premature recycling).

Returns:

ByteBufMono of retained ByteBuf

retain

public final ByteBufFlux retain()

Disable auto memory release on each buffer published, retaining in order to prevent premature recycling when buffers are accumulated downstream (async).

Returns:

ByteBufFlux of retained ByteBuf

subscribe

public void subscribe(CoreSubscriber<? super ByteBuf> s)

Specified by:

subscribe in interface CorePublisher<ByteBuf>

Specified by:

subscribe in class Flux<ByteBuf>