Package com.linecorp.armeria.common.stream

Class DefaultStreamMessageDuplicator<T>

java.lang.Object

com.linecorp.armeria.common.stream.DefaultStreamMessageDuplicator<T>

Type Parameters:

T - the type of elements

All Implemented Interfaces:

StreamMessageDuplicator<T>, SafeCloseable, AutoCloseable

@UnstableApi
public class DefaultStreamMessageDuplicator<T>
extends Object
implements StreamMessageDuplicator<T>

A default duplicator.

See Also:

StreamMessageDuplicator

Constructor Summary

Constructors

Constructor	Description
DefaultStreamMessageDuplicator(StreamMessage<T> upstream, SignalLengthGetter<? super T> signalLengthGetter, EventExecutor executor, long maxSignalLength)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	abort()	Closes this duplicator and aborts all stream messages returned by StreamMessageDuplicator.duplicate().
void	abort(Throwable cause)	Closes this duplicator and aborts all stream messages returned by StreamMessageDuplicator.duplicate() with the specified Throwable.
void	close()	Closes this duplicator and prevents it from further duplication.
StreamMessage<T>	duplicate()	Returns a new StreamMessage that publishes the same elements as the StreamMessage that this duplicator is created from.
protected EventExecutor	duplicatorExecutor()	Returns the default EventExecutor which will be used when a user subscribes to a child stream using StreamMessage.subscribe(Subscriber, SubscriptionOption...).

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultStreamMessageDuplicator

public DefaultStreamMessageDuplicator(StreamMessage<T> upstream, SignalLengthGetter<? super T> signalLengthGetter, EventExecutor executor, long maxSignalLength)

Creates a new instance.

Method Details

duplicate

public StreamMessage<T> duplicate()

Description copied from interface: StreamMessageDuplicator

Returns a new StreamMessage that publishes the same elements as the StreamMessage that this duplicator is created from.

Specified by:

duplicate in interface StreamMessageDuplicator<T>

duplicatorExecutor

protected EventExecutor duplicatorExecutor()

Returns the default EventExecutor which will be used when a user subscribes to a child stream using StreamMessage.subscribe(Subscriber, SubscriptionOption...).

close

public void close()

Description copied from interface: StreamMessageDuplicator

Closes this duplicator and prevents it from further duplication. StreamMessageDuplicator.duplicate() will raise an IllegalStateException after this method is invoked.

Note that the previously duplicated streams will not be closed but will continue publishing data until the original StreamMessage is closed. All the data published from the original StreamMessage are cleaned up when all duplicated streams are complete. If you want to stop publishing and clean up the resources immediately, call StreamMessageDuplicator.abort().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable

Specified by:

close in interface StreamMessageDuplicator<T>

abort

public void abort()

Description copied from interface: StreamMessageDuplicator

Closes this duplicator and aborts all stream messages returned by StreamMessageDuplicator.duplicate(). This will also clean up the data published from the original StreamMessage.

Specified by:

abort in interface StreamMessageDuplicator<T>

abort

public void abort(Throwable cause)

Description copied from interface: StreamMessageDuplicator

Closes this duplicator and aborts all stream messages returned by StreamMessageDuplicator.duplicate() with the specified Throwable. This will also clean up the data published from the original StreamMessage.

Specified by:

abort in interface StreamMessageDuplicator<T>