Reactive Streams for .NET
Clone or download
alexvaluyskiy and marcpiechura Added xml documentation (#42)
* added xml documentation

* Updated NUnit runner
4
Latest commit f1a95c6 Aug 8, 2017

README.md

Reactive Streams .NET#

The purpose of Reactive Streams is to provide a standard for asynchronous stream processing with non-blocking backpressure.

The latest release is available on NuGet.

To install Reactive Streams, run the following command in the Package Manager Console

PM> Install-Package Reactive.Streams

Goals, Design and Scope

Handling streams of data—especially “live” data whose volume is not predetermined—requires special care in an asynchronous system. The most prominent issue is that resource consumption needs to be carefully controlled such that a fast data source does not overwhelm the stream destination. Asynchrony is needed in order to enable the parallel use of computing resources, on collaborating network hosts or multiple CPU cores within a single machine.

The main goal of Reactive Streams is to govern the exchange of stream data across an asynchronous boundary – think passing elements on to another thread or thread-pool — while ensuring that the receiving side is not forced to buffer arbitrary amounts of data. In other words, backpressure is an integral part of this model in order to allow the queues which mediate between threads to be bounded. The benefits of asynchronous processing would be negated if the communication of backpressure were synchronous (see also the Reactive Manifesto), therefore care has been taken to mandate fully non-blocking and asynchronous behavior of all aspects of a Reactive Streams implementation.

It is the intention of this specification to allow the creation of many conforming implementations, which by virtue of abiding by the rules will be able to interoperate smoothly, preserving the aforementioned benefits and characteristics across the whole processing graph of a stream application.

It should be noted that the precise nature of stream manipulations (transformation, splitting, merging, etc.) is not covered by this specification. Reactive Streams are only concerned with mediating the stream of data between different API Components. In their development care has been taken to ensure that all basic ways of combining streams can be expressed.

In summary, Reactive Streams .NET is a standard and specification for Stream-oriented libraries for .NET that

  • process a potentially unbounded number of elements
  • in sequence,
  • asynchronously passing elements between components,
  • with mandatory non-blocking backpressure.

The Reactive Streams specification consists of the following parts:

The API specifies the types to implement Reactive Streams and achieve interoperability between different implementations.

The Technology Compatibility Kit (TCK) is a standard test suite for conformance testing of implementations.

Implementations are free to implement additional features not covered by the specification as long as they conform to the API requirements and pass the tests in the TCK.

API Components

The API consists of the following components that are required to be provided by Reactive Stream implementations:

  1. IPublisher
  2. ISubscriber
  3. ISubscription
  4. IProcessor

An IPublisher is a provider of a potentially unbounded number of sequenced elements, publishing them according to the demand received from its ISubscriber(s).

In response to a call to IPublisher.Subscribe(ISubscriber) the possible invocation sequences for methods on the ISubscriber are given by the following protocol:

onSubscribe onNext* (onError | onComplete)?

This means that onSubscribe is always signalled, followed by a possibly unbounded number of onNext signals (as requested by ISubscriber) followed by an onError signal if there is a failure, or an onComplete signal when no more elements are available—all as long as the ISubscription is not cancelled.

NOTES

  • The specifications below use binding words in capital letters from https://www.ietf.org/rfc/rfc2119.txt
  • The terms emit, signal or send are interchangeable. The specifications below will use signal.
  • The terms synchronously or synchronous refer to executing in the calling Thread.
  • The term "return normally" means "only throws exceptions that are explicitly allowed by the rule".

SPECIFICATION

1. IPublisher (Code)

public interface IPublisher<out T> {
    void Subscribe(ISubscriber<T> subscriber);
}
ID Rule
1 The total number of onNext signals sent by an IPublisher to an ISubscriber MUST be less than or equal to the total number of elements requested by that ISubscriber´s ISubscription at all times.
2 An IPublisher MAY signal less onNext than requested and terminate the ISubscription by calling OnComplete or OnError.
3 onSubscribe, onNext, onError and onComplete signaled to an ISubscriber MUST be signaled sequentially (no concurrent notifications).
4 If an IPublisher fails it MUST signal an onError.
5 If an IPublisher terminates successfully (finite stream) it MUST signal an onComplete.
6 If an IPublisher signals either onError or onComplete on an ISubscriber, that ISubscriber’s ISubscription MUST be considered cancelled.
7 Once a terminal state has been signaled (onError, onComplete) it is REQUIRED that no further signals occur.
8 If an ISubscription is cancelled its ISubscriber MUST eventually stop being signaled.
9 IPublisher.Subscribe MUST call OnSubscribe on the provided ISubscriber prior to any other signals to that ISubscriber and MUST return normally, except when the provided ISubscriber is null in which case it MUST throw a System.ArgumentNullException to the caller, for all other situations [1] the only legal way to signal failure (or reject the ISubscriber) is by calling OnError (after calling OnSubscribe).
10 IPublisher.Subscribe MAY be called as many times as wanted but MUST be with a different ISubscriber each time [see 2.12].
11 An IPublisher MAY support multiple ISubscribers and decides whether each ISubscription is unicast or multicast.

[1] : A stateful IPublisher can be overwhelmed, bounded by a finite number of underlying resources, exhausted, shut-down or in a failed state.

2. ISubscriber (Code)

public interface ISubscriber<in T> {
    public void OnSubscribe(ISubscription subscription);
    public void OnNext(T element);
    public void OnError(Exception cause);
    public void OnComplete();
}
ID Rule
1 An ISubscriber MUST signal demand via ISubscription.Request(long n) to receive onNext signals.
2 If an ISubscriber suspects that its processing of signals will negatively impact its IPublisher's responsivity, it is RECOMMENDED that it asynchronously dispatches its signals.
3 ISubscriber.OnComplete() and ISubscriber.OnError(Exception cause) MUST NOT call any methods on the ISubscription or the IPublisher.
4 ISubscriber.OnComplete() and ISubscriber.OnError(Exception cause) MUST consider the ISubscription cancelled after having received the signal.
5 An ISubscriber MUST call ISubscription.Cancel() on the given ISubscription after an onSubscribe signal if it already has an active ISubscription.
6 An ISubscriber MUST call ISubscription.Cancel() if it is no longer valid to the IPublisher without the IPublisher having signaled onError or onComplete.
7 An ISubscriber MUST ensure that all calls on its ISubscription take place from the same thread or provide for respective external synchronization.
8 An ISubscriber MUST be prepared to receive one or more onNext signals after having called ISubscription.Cancel() if there are still requested elements pending [see 3.12]. ISubscription.Cancel() does not guarantee to perform the underlying cleaning operations immediately.
9 An ISubscriber MUST be prepared to receive an onComplete signal with or without a preceding ISubscription.Request(long n) call.
10 An ISubscriber MUST be prepared to receive an onError signal with or without a preceding ISubscription.Request(long n) call.
11 An ISubscriber MUST make sure that all calls on its OnXXX methods happen-before [1] the processing of the respective signals. I.e. the ISubscriber must take care of properly publishing the signal to its processing logic.
12 ISubscriber.OnSubscribe MUST be called at most once for a given ISubscriber (based on object equality).
13 Calling OnSubscribe, OnNext, OnError or OnComplete MUST return normally except when any provided parameter is null in which case it MUST throw a System.ArgumentNullException to the caller, for all other situations the only legal way for an ISubscriber to signal failure is by cancelling its ISubscription. In the case that this rule is violated, any associated ISubscription to the ISubscriber MUST be considered as cancelled, and the caller MUST raise this error condition in a fashion that is adequate for the runtime environment.

[1] : See JMM definition of Happen-Before in section 17.4.5. on http://docs.oracle.com/javase/specs/jls/se7/html/jls-17.html

3. ISubscription (Code)

public interface ISubscription {
    public void Request(long n);
    public void Cancel();
}
ID Rule
1 ISubscription.Request and ISubscription.Cancel MUST only be called inside of its ISubscriber context. An ISubscription represents the unique relationship between an ISubscriber and an IPublisher [see 2.12].
2 The ISubscription MUST allow the ISubscriber to call ISubscription.Request synchronously from within OnNext or OnSubscribe.
3 ISubscription.Request MUST place an upper bound on possible synchronous recursion between IPublisher and ISubscriber[1].
4 ISubscription.Request SHOULD respect the responsivity of its caller by returning in a timely manner[2].
5 ISubscription.Cancel MUST respect the responsivity of its caller by returning in a timely manner[2], MUST be idempotent and MUST be thread-safe.
6 After the ISubscription is cancelled, additional ISubscription.Request(long n) MUST be NOPs.
7 After the ISubscription is cancelled, additional ISubscription.Cancel() MUST be NOPs.
8 While the ISubscription is not cancelled, ISubscription.Request(long n) MUST register the given number of additional elements to be produced to the respective subscriber.
9 While the ISubscription is not cancelled, ISubscription.Request(long n) MUST signal onError with a System.ArgumentException if the argument is <= 0. The cause message MUST include a reference to this rule and/or quote the full rule.
10 While the ISubscription is not cancelled, ISubscription.Request(long n) MAY synchronously call OnNext on this (or other) subscriber(s).
11 While the ISubscription is not cancelled, ISubscription.Request(long n) MAY synchronously call OnComplete or OnError on this (or other) subscriber(s).
12 While the ISubscription is not cancelled, ISubscription.Cancel() MUST request the IPublisher to eventually stop signaling its ISubscriber. The operation is NOT REQUIRED to affect the ISubscription immediately.
13 While the ISubscription is not cancelled, ISubscription.Cancel() MUST request the IPublisher to eventually drop any references to the corresponding subscriber. Re-subscribing with the same ISubscriber object is discouraged [see 2.12], but this specification does not mandate that it is disallowed since that would mean having to store previously cancelled subscriptions indefinitely.
14 While the ISubscription is not cancelled, calling ISubscription.Cancel MAY cause the IPublisher, if stateful, to transition into the shut-down state if no other ISubscription exists at this point [see 1.9].
15 Calling ISubscription.Cancel MUST return normally. The only legal way to signal failure to an ISubscriber is via the OnError method.
16 Calling ISubscription.Request MUST return normally. The only legal way to signal failure to an ISubscriber is via the OnError method.
17 An ISubscription MUST support an unbounded number of calls to Request and MUST support a demand (sum requested - sum delivered) up to 2^63-1 (System.Int64.MaxValue). A demand equal or greater than 2^63-1 (System.Int64.MaxValue) MAY be considered by the IPublisher as “effectively unbounded”[3].

[1] : An example for undesirable synchronous, open recursion would be ISubscriber.OnNext -> ISubscription.Request -> ISubscriber.OnNext -> …, as it very quickly would result in blowing the calling Thread´s stack.

[2] : Avoid heavy computations and other things that would stall the caller´s thread of execution

[3] : As it is not feasibly reachable with current or foreseen hardware within a reasonable amount of time (1 element per nanosecond would take 292 years) to fulfill a demand of 2^63-1, it is allowed for an IPublisher to stop tracking demand beyond this point.

An ISubscription is shared by exactly one IPublisher and one ISubscriber for the purpose of mediating the data exchange between this pair. This is the reason why the Subscribe() method does not return the created ISubscription, but instead returns void; the ISubscription is only passed to the ISubscriber via the OnSubscribe callback.

4.IProcessor (Code)

public interface IProcessor<in T1, out T2> : ISubscriber<T1>, IPublisher<T2> {
}
ID Rule
1 An IProcessor represents a processing stage—which is both an ISubscriber and an IPublisher and MUST obey the contracts of both.
2 An IProcessor MAY choose to recover an onError signal. If it chooses to do so, it MUST consider the ISubscription cancelled, otherwise it MUST propagate the onError signal to its ISubscribers immediately.

While not mandated, it can be a good idea to cancel an IProcessors upstream ISubscription when/if its last ISubscriber cancels their ISubscription, to let the cancellation signal propagate upstream.

Asynchronous vs Synchronous Processing

The Reactive Streams API prescribes that all processing of elements (onNext) or termination signals (onError, onComplete) MUST NOT block the IPublisher. However, each of the On* handlers can process the events synchronously or asynchronously.

Take this example:

nioSelectorThreadOrigin map(f) filter(p) consumeTo(toNioSelectorOutput)

It has an async origin and an async destination. Let's assume that both origin and destination are selector event loops. The ISubscription.Request(n) must be chained from the destination to the origin. This is now where each implementation can choose how to do this.

The following uses the pipe | character to signal async boundaries (queue and schedule) and R# to represent resources (possibly threads).

nioSelectorThreadOrigin | map(f) | filter(p) | consumeTo(toNioSelectorOutput)
-------------- R1 ----  | - R2 - | -- R3 --- | ---------- R4 ----------------

In this example each of the 3 consumers, map, filter and consumeTo asynchronously schedule the work. It could be on the same event loop (trampoline), separate threads, whatever.

nioSelectorThreadOrigin map(f) filter(p) | consumeTo(toNioSelectorOutput)
------------------- R1 ----------------- | ---------- R2 ----------------

Here it is only the final step that asynchronously schedules, by adding work to the NioSelectorOutput event loop. The map and filter steps are synchronously performed on the origin thread.

Or another implementation could fuse the operations to the final consumer:

nioSelectorThreadOrigin | map(f) filter(p) consumeTo(toNioSelectorOutput)
--------- R1 ---------- | ------------------ R2 -------------------------

All of these variants are "asynchronous streams". They all have their place and each has different tradeoffs including performance and implementation complexity.

The Reactive Streams contract allows implementations the flexibility to manage resources and scheduling and mix asynchronous and synchronous processing within the bounds of a non-blocking, asynchronous, dynamic push-pull stream.

In order to allow fully asynchronous implementations of all participating API elements—IPublisher/ISubscription/ISubscriber/IProcessor—all methods defined by these interfaces return void.

ISubscriber controlled queue bounds

One of the underlying design principles is that all buffer sizes are to be bounded and these bounds must be known and controlled by the subscribers. These bounds are expressed in terms of element count (which in turn translates to the invocation count of onNext). Any implementation that aims to support infinite streams (especially high output rate streams) needs to enforce bounds all along the way to avoid out-of-memory errors and constrain resource usage in general.

Since back-pressure is mandatory the use of unbounded buffers can be avoided. In general, the only time when a queue might grow without bounds is when the publisher side maintains a higher rate than the subscriber for an extended period of time, but this scenario is handled by backpressure instead.

Queue bounds can be controlled by a subscriber signaling demand for the appropriate number of elements. At any point in time the subscriber knows:

  • the total number of elements requested: P
  • the number of elements that have been processed: N

Then the maximum number of elements that may arrive—until more demand is signaled to the IPublisher—is P - N. In the case that the subscriber also knows the number of elements B in its input buffer then this bound can be refined to P - B - N.

These bounds must be respected by a publisher independent of whether the source it represents can be backpressured or not. In the case of sources whose production rate cannot be influenced—for example clock ticks or mouse movement—the publisher must choose to either buffer or drop elements to obey the imposed bounds.

ISubscribers signaling a demand for one element after the reception of an element effectively implement a Stop-and-Wait protocol where the demand signal is equivalent to acknowledgement. By providing demand for multiple elements the cost of acknowledgement is amortized. It is worth noting that the subscriber is allowed to signal demand at any point in time, allowing it to avoid unnecessary delays between the publisher and the subscriber (i.e. keeping its input buffer filled without having to wait for full round-trips).

Legal

This project is a collaboration between engineers from Kaazing, Netflix, Pivotal, Red Hat, Twitter, Typesafe and many others. The code is offered to the Public Domain in order to allow free use by interested parties who want to create compatible implementations. For details see COPYING.

CC0
To the extent possible under law, Reactive Streams Special Interest Group has waived all copyright and related or neighboring rights to Reactive Streams .NET. This work is published from: United States.