groovyx.gpars.dataflow.stream
[Java] Class SyncDataflowStream

java.lang.Object
  groovyx.gpars.dataflow.stream.StreamCore
      groovyx.gpars.dataflow.stream.SyncDataflowStream

@SuppressWarnings({"rawtypes", "TailRecursion", "unchecked", "StaticMethodNamingConvention", "ClassWithTooManyMethods"})
public final class SyncDataflowStream
extends StreamCore

Represents a synchronous deterministic dataflow channel. Unlike a SyncDataflowQueue, syncDataflowStream allows multiple readers each to read all the messages. Essentially, you may think of SyncDataflowStream as a 1 to many communication channel, since when a reader consumes a messages, other readers will still be able to read the message. Also, all messages arrive to all readers in the same order. SyncDataflowStream is implemented as a functional queue, which impacts the API in that users have to traverse the values in the stream themselves. On the other hand in offers handy methods for value filtering or transformation together with interesting performance characteristics. For convenience and for the ability to use SyncDataflowStream with other dataflow constructs, like e.g. operators, you can wrap SyncDataflowStreams with DataflowReadAdapter for read access or DataflowWriteAdapter for write access.

The SyncDataflowStream class is designed for single-threaded producers and consumers. If multiple threads are supposed to read or write values to the stream, their access to the stream must be serialized externally or the adapters should be used.

SyncDataflowStream uses SyncDataflowVariables to preform the actual data exchange. Unlike DataflowStream, which exchanges data in asynchronous manner, SyncDataflowStream is synchronous. The writer as well as the readers are blocked until all the required parties become ready for the data exchange. Writers can thus never get too far ahead of readers and also all the readers themselves are always processing the same message in parallel and wait for one-another before getting the next one.

Parameters:

- Type for values to pass through the stream

Authors:

Vaclav Pech

parties

private int parties

SyncDataflowStream

public SyncDataflowStream(int parties)

Creates an empty stream

Parameters:

parties - The number of readers to ask for a value before the message gets exchanged.

SyncDataflowStream

public SyncDataflowStream(int parties, groovy.lang.Closure toBeApplied)

Creates an empty stream while applying the supplied initialization closure to it

Parameters:

parties - The number of readers to ask for a value before the message gets exchanged.

toBeApplied - The closure to use for initialization

SyncDataflowStream

private SyncDataflowStream(int parties, java.util.Collection wheneverBoundListeners, java.util.Collection updateListeners)

Creates an empty stream with the specified listeners set

Parameters:

parties - The number of readers to ask for a value before the message gets exchanged.

wheneverBoundListeners - The collection of listeners to bind to the stream

appendingString

@Override
public java.lang.String appendingString()

createNewStream

@Override
protected StreamCore createNewStream()

A factory method to create new instances of the correct class when needed

Returns:

An instance of the appropriate sub-class

decrementParties

@Override
public void decrementParties()

Decreases the number of parties required to perform the data exchange

getRest

@Override
public FList getRest()

Retrieves a DataflowStream representing the rest of this Stream after removing the first element

Returns:

The remaining stream elements

incrementParties

@Override
public void incrementParties()

Increases the number of parties required to perform the data exchange

isEmptyWithRespectToSync

private boolean isEmptyWithRespectToSync()

toString

@Override
public java.lang.String toString()

Copyright © 2008–2012 Václav Pech. All Rights Reserved.