cyclops.async

Class Topic<T>

java.lang.Object

cyclops.async.Topic<T>

Type Parameters:

T - Data type for the Topic

All Implemented Interfaces:

Adapter<T>

public class Topic<T>
extends java.lang.Object
implements Adapter<T>

A class that can accept input streams and generate output streams where data sent in the Topic is guaranteed to be provided to all Topic subsribers

Constructor Summary

Constructors

Constructor and Description
Topic() Construct a new Topic
Topic(Queue<T> q) Construct a Topic using the Queue provided

Method Summary

Modifier and Type	Method and Description
boolean	close() Close this Topic
void	disconnect(java.util.stream.Stream<T> stream) Topic will maintain a queue for each Subscribing Stream If a Stream is finished with a Topic it is good practice to disconnect from the Topic so messages will no longer be stored for that Stream
boolean	fromStream(java.util.stream.Stream<T> stream)
Signal<java.lang.Integer>	getSizeSignal(int index)
boolean	offer(T data) Add a single datapoint to this Queue
void	setSizeSignal(int index, Signal<java.lang.Integer> s)
ReactiveSeq<T>	stream() Generating a stream will register the Stream as a subscriber to this topic.
ReactiveSeq<T>	stream(Continueable s)
ReactiveSeq<java.util.concurrent.CompletableFuture<T>>	streamCompletableFutures() Generating a streamCompletableFutures will register the Stream as a subscriber to this topic.
<R> R	visit(java.util.function.Function<? super Queue<T>,? extends R> caseQueue, java.util.function.Function<? super Topic<T>,? extends R> caseTopic) Conditionally execute one of the supplied function depending on whether or not this Adapter is a Queue or a Topic

Methods inherited from class java.lang.Object

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

Methods inherited from interface cyclops.async.Adapter

futureStream, futureStream, matches

Constructor Detail

Topic

public Topic()

Construct a new Topic

Topic

public Topic(Queue<T> q)

Construct a Topic using the Queue provided

Parameters:

q - Queue to back this Topic with

Method Detail

disconnect

public void disconnect(java.util.stream.Stream<T> stream)

Topic will maintain a queue for each Subscribing Stream If a Stream is finished with a Topic it is good practice to disconnect from the Topic so messages will no longer be stored for that Stream

Parameters:

stream -

fromStream

public boolean fromStream(java.util.stream.Stream<T> stream)

Specified by:

fromStream in interface Adapter<T>

Parameters:

stream - Input data from provided Stream

streamCompletableFutures

public ReactiveSeq<java.util.concurrent.CompletableFuture<T>> streamCompletableFutures()

Generating a streamCompletableFutures will register the Stream as a subscriber to this topic. It will be provided with an internal Queue as a mailbox. @see Topic.disconnect to disconnect from the topic

Specified by:

streamCompletableFutures in interface Adapter<T>

Returns:

Stream of CompletableFutures that can be used as input into a SimpleReact concurrent dataflow

stream

public ReactiveSeq<T> stream()

Generating a stream will register the Stream as a subscriber to this topic. It will be provided with an internal Queue as a mailbox. @see Topic.disconnect to disconnect from the topic

Specified by:

stream in interface Adapter<T>

Returns:

Stream of data

stream

public ReactiveSeq<T> stream(Continueable s)

Specified by:

stream in interface Adapter<T>

Returns:

Stream of data

close

public boolean close()

Close this Topic

Specified by:

close in interface Adapter<T>

Returns:

true if closed

getSizeSignal

public Signal<java.lang.Integer> getSizeSignal(int index)

Returns:

Track changes in size in the Topic's data

setSizeSignal

public void setSizeSignal(int index,
                          Signal<java.lang.Integer> s)

offer

public boolean offer(T data)

Add a single datapoint to this Queue

Specified by:

offer in interface Adapter<T>

Parameters:

data - data to add

Returns:

self

visit

public <R> R visit(java.util.function.Function<? super Queue<T>,? extends R> caseQueue,
                   java.util.function.Function<? super Topic<T>,? extends R> caseTopic)

Description copied from interface: Adapter

Conditionally execute one of the supplied function depending on whether or not this Adapter is a Queue or a Topic

Specified by:

visit in interface Adapter<T>

Parameters:

caseQueue - Function to execute if this Adapter is a Queue

caseTopic - Function to execute if this Adapter is a Topic

Returns:

Value returned from executed funciton