Package io.helidon.common.reactive

Class SubmissionPublisher<T>

java.lang.Object

io.helidon.common.reactive.SubmissionPublisher<T>

Type Parameters:

T - the published item type

All Implemented Interfaces:

Flow.Publisher<T>, java.lang.AutoCloseable

public class SubmissionPublisher<T>
extends java.lang.Object
implements Flow.Publisher<T>, java.lang.AutoCloseable

A Flow.Publisher that asynchronously issues submitted (non-null) items to current subscribers until it is closed.

Constructor Summary

Constructors

Constructor	Description
SubmissionPublisher()	Creates a new SubmissionPublisher using the current thread for delivery to subscribers, with maximum buffer capacity of Flow.defaultBufferSize().
SubmissionPublisher(int maxBufferCapacity)	Creates a new SubmissionPublisher using the current thread for delivery to subscribers, with the given maximum buffer size for each subscriber.
SubmissionPublisher(java.util.concurrent.Executor executor, int maxBufferCapacity)	Creates a new SubmissionPublisher using the given Executor for async delivery to subscribers, with the given maximum buffer size for each subscriber.

Method Summary

Modifier and Type	Method	Description
void	close()
void	closeExceptionally(java.lang.Throwable error)	Unless already closed, issues onError signals to current subscribers with the given error, and disallows subsequent attempts to publish.
int	getNumberOfSubscribers()	Returns the number of current subscribers.
boolean	hasSubscribers()	Returns true if this publisher has any subscribers.
void	offer(T item, java.util.function.BiPredicate<Flow.Subscriber<? super T>,? super T> onDrop)	Publishes the given item to each current subscriber.
void	submit(T item)	Publishes the given item to each current subscriber.
void	subscribe(Flow.Subscriber<? super T> subscriber)	Adds the given Subscriber.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmissionPublisher

public SubmissionPublisher(java.util.concurrent.Executor executor,
                           int maxBufferCapacity)

Creates a new SubmissionPublisher using the given Executor for async delivery to subscribers, with the given maximum buffer size for each subscriber.

Parameters:

executor - the executor to use for async delivery, supporting creation of at least one independent thread

maxBufferCapacity - the maximum capacity for each subscriber's buffer

Throws:

java.lang.IllegalArgumentException - if maxBufferCapacity not positive

SubmissionPublisher

public SubmissionPublisher(int maxBufferCapacity)

Creates a new SubmissionPublisher using the current thread for delivery to subscribers, with the given maximum buffer size for each subscriber.

Parameters:

maxBufferCapacity - the maximum capacity for each subscriber's buffer

Throws:

java.lang.IllegalArgumentException - if maxBufferCapacity not

SubmissionPublisher

public SubmissionPublisher()

Creates a new SubmissionPublisher using the current thread for delivery to subscribers, with maximum buffer capacity of Flow.defaultBufferSize().

Method Detail

subscribe

public void subscribe(Flow.Subscriber<? super T> subscriber)

Adds the given Subscriber.

Specified by:

subscribe in interface Flow.Publisher<T>

Parameters:

subscriber - the subscriber

Throws:

java.lang.NullPointerException - if subscriber is null

submit

public void submit(T item)

Publishes the given item to each current subscriber.

Parameters:

item - the (non-null) item to publish

Throws:

java.lang.NullPointerException - if item is null

offer

public void offer(T item,
                  java.util.function.BiPredicate<Flow.Subscriber<? super T>,? super T> onDrop)

Publishes the given item to each current subscriber.

Parameters:

item - the (non-null) item to publish

onDrop - not supported in the current implementation

Throws:

java.lang.NullPointerException - if item is null

closeExceptionally

public void closeExceptionally(java.lang.Throwable error)

Unless already closed, issues onError signals to current subscribers with the given error, and disallows subsequent attempts to publish. Future subscribers also receive the given error. Upon return, this method does NOT guarantee that all subscribers have yet completed.

Parameters:

error - the onError argument sent to subscribers

Throws:

java.lang.NullPointerException - if error is null

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

getNumberOfSubscribers

public int getNumberOfSubscribers()

Returns the number of current subscribers.

Returns:

the number of current subscribers

hasSubscribers

public boolean hasSubscribers()

Returns true if this publisher has any subscribers.

Returns:

true if this publisher has any subscribers