|
1 | 1 | # Reactive Streams
|
2 | 2 |
|
3 |
| -Reactive Streams is an initiative to provide a standard for asynchronous stream processing with non-blocking back pressure on the JVM. |
4 |
| - |
5 |
| -## The Problem |
| 3 | +Reactive Streams is an initiative to provide a standard for asynchronous stream processing with non-blocking back pressure on the JVM. |
| 4 | + |
| 5 | +## The Problem |
6 | 6 |
|
7 | 7 | 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.
|
8 |
| - |
9 |
| -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, back pressure 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 back pressure were synchronous (see also the [Reactive Manifesto](http://reactivemanifesto.org/)), therefore care has been taken to mandate fully non-blocking and asynchronous behavior of all aspects of a Reactive Streams implementation. |
10 |
| - |
11 |
| -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. |
12 |
| - |
13 |
| -## Scope |
14 |
| - |
15 |
| -The scope of Reactive Streams is to find a minimal set of interfaces and methods that will describe the necessary operations and entities to achieve the goal—asynchronous streams of data with non-blocking back pressure. |
16 |
| - |
17 |
| -End-user DSLs to create instances of the API interfaces have purposefully been left out of the scope to encourage and enable different implementations that potentially use different programming languages to stay as true as possible to the idioms of that platform. |
18 |
| - |
19 |
| -We anticipate that acceptance of this Reactive Streams specification and experience with its implementations will together lead to standardized Java platform support in future JDK releases. |
20 |
| - |
21 |
| -## First Draft Specification |
22 |
| - |
| 8 | + |
| 9 | +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, back pressure 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 back pressure were synchronous (see also the [Reactive Manifesto](http://reactivemanifesto.org/)), therefore care has been taken to mandate fully non-blocking and asynchronous behavior of all aspects of a Reactive Streams implementation. |
| 10 | + |
| 11 | +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. |
| 12 | + |
| 13 | +## Scope |
| 14 | + |
| 15 | +The scope of Reactive Streams is to find a minimal set of interfaces and methods that will describe the necessary operations and entities to achieve the goal—asynchronous streams of data with non-blocking back pressure. |
| 16 | + |
| 17 | +End-user DSLs to create instances of the API interfaces have purposefully been left out of the scope to encourage and enable different implementations that potentially use different programming languages to stay as true as possible to the idioms of that platform. |
| 18 | + |
| 19 | +We anticipate that acceptance of this Reactive Streams specification and experience with its implementations will together lead to standardized Java platform support in future JDK releases. |
| 20 | + |
| 21 | +## First Draft Specification |
| 22 | + |
23 | 23 | Available immediately is a First Draft Specification covering:
|
24 |
| - |
25 |
| -* [Semantics](https://github.com/reactive-streams/reactive-streams/blob/v0.3/tck/src/main/resources/spec.md)—a specification document |
26 |
| -* [API](https://github.com/reactive-streams/reactive-streams/tree/v0.3/spi/src/main/java/org/reactivestreams/api/)—Java interfaces for end users |
27 |
| -* [SPI](https://github.com/reactive-streams/reactive-streams/tree/v0.3/spi/src/main/java/org/reactivestreams/spi/)—Java interfaces for implementations |
28 |
| -* [TCK](https://github.com/reactive-streams/reactive-streams/tree/v0.3/tck/src/main/java/org/reactivestreams/tck/)—a test harness to validate implementations and guide implementors |
29 |
| - |
30 |
| -All of the parts of the Draft Proposal is released under [Creative Commons Zero](http://creativecommons.org/publicdomain/zero/1.0) (Public Domain). |
31 |
| - |
32 |
| -## Users |
33 |
| - |
34 |
| -Don’t hesitate to take a look at or try out some of the early implementations of the draft spec! |
35 |
| - |
36 |
| -For feedback on |
| 24 | + |
| 25 | +* [Semantics](https://github.com/reactive-streams/reactive-streams/blob/v0.3/tck/src/main/resources/spec.md)—a specification document |
| 26 | +* [API](https://github.com/reactive-streams/reactive-streams/tree/v0.3/spi/src/main/java/org/reactivestreams/api/)—Java interfaces for end users |
| 27 | +* [SPI](https://github.com/reactive-streams/reactive-streams/tree/v0.3/spi/src/main/java/org/reactivestreams/spi/)—Java interfaces for implementations |
| 28 | +* [TCK](https://github.com/reactive-streams/reactive-streams/tree/v0.3/tck/src/main/java/org/reactivestreams/tck/)—a test harness to validate implementations and guide implementors |
| 29 | + |
| 30 | +All of the parts of the Draft Proposal is released under [Creative Commons Zero](http://creativecommons.org/publicdomain/zero/1.0) (Public Domain). |
| 31 | + |
| 32 | +## Users |
| 33 | + |
| 34 | +Don’t hesitate to take a look at or try out some of the early implementations of the draft spec! |
| 35 | + |
| 36 | +For feedback on |
37 | 37 |
|
38 | 38 | * the draft spec, the Reactive Streams initiative or general feedback:
|
39 | 39 |
|
40 | 40 | please open an Issue on the [Reactive Streams project](https://github.com/reactive-streams/reactive-streams/issues).
|
41 |
| - |
42 |
| -* the implementations themselves: |
43 |
| - |
44 |
| - please direct that to the implementor via their preferred feedback system listed below. |
45 |
| - |
46 |
| -### Implementations of the draft spec |
47 |
| - |
48 |
| -* Akka Streams |
49 |
| - * See this [Activator template](http://www.typesafe.com/activator/template/akka-stream-scala) introducing the [Akka Project](http://akka.io/) implementation in Scala; a Java version will follow shortly. |
50 |
| - * Please give [Feedback](http://doc.akka.io/docs/akka/current/project/issue-tracking.html) on the issue tracker. |
51 |
| -* Reactor Composable |
52 |
| - * [Reactor (1.1+)](http://github.com/reactor/reactor) |
53 |
| - * Current Implementation Draft is being explored for 1.1 and onwards, see Reactor Composable |
| 41 | + |
| 42 | +* the implementations themselves: |
| 43 | + |
| 44 | + please direct that to the implementor via their preferred feedback system listed below. |
| 45 | + |
| 46 | +### Implementations of the draft spec |
| 47 | + |
| 48 | +* Akka Streams |
| 49 | + * See this [Activator template](http://www.typesafe.com/activator/template/akka-stream-scala) introducing the [Akka Project](http://akka.io/) implementation in Scala; a Java version will follow shortly. |
| 50 | + * Please give [Feedback](http://doc.akka.io/docs/akka/current/project/issue-tracking.html) on the issue tracker. |
| 51 | +* Reactor Composable |
| 52 | + * [Reactor (1.1+)](http://github.com/reactor/reactor) |
| 53 | + * Current Implementation Draft is being explored for 1.1 and onwards, see Reactor Composable |
54 | 54 | * RxJava
|
55 |
| - * Support being [prototyped and explored](https://github.com/Netflix/RxJava/issues/1000) for inclusion in RxJava 1.0 |
56 |
| - |
57 |
| -## Implementors |
58 |
| - |
59 |
| -To get started implementing the draft specification, it is recommended to start by reading the [README](https://github.com/reactive-streams/reactive-streams/blob/v0.3/README.md), then taking a look at the [Specification](https://github.com/reactive-streams/reactive-streams/blob/v0.3/tck/src/main/resources/spec.md) then taking a look at the [TCK](https://github.com/reactive-streams/reactive-streams/tree/v0.3/tck/src/main/java/org/reactivestreams/tck/). If you have an issue with any of the above, please take a look at [closed issues](https://github.com/reactive-streams/reactive-streams/issues?page=1&state=closed) and then open a [new issue](https://github.com/reactive-streams/reactive-streams/issues/new) if it has not already been answered. |
| 55 | + * See [github.com/ReactiveX/RxJavaReactiveStreams](https://github.com/ReactiveX/RxJavaReactiveStreams). |
| 56 | +* [Ratpack](http://www.ratpack.io) |
| 57 | + * See the [“Streams”](http://www.ratpack.io/manual/current/streams.html) chapter of the manual. |
| 58 | + |
| 59 | +## Implementors |
| 60 | + |
| 61 | +To get started implementing the draft specification, it is recommended to start by reading the [README](https://github.com/reactive-streams/reactive-streams/blob/v0.3/README.md), then taking a look at the [Specification](https://github.com/reactive-streams/reactive-streams/blob/v0.3/tck/src/main/resources/spec.md) then taking a look at the [TCK](https://github.com/reactive-streams/reactive-streams/tree/v0.3/tck/src/main/java/org/reactivestreams/tck/). If you have an issue with any of the above, please take a look at [closed issues](https://github.com/reactive-streams/reactive-streams/issues?page=1&state=closed) and then open a [new issue](https://github.com/reactive-streams/reactive-streams/issues/new) if it has not already been answered. |
0 commit comments