SpringCloud/spring-cloud-stream
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-2164 Update documentation

Browse Source 
Remove obsolete docs and add deprecations and update what's new section

Resolves #2164
This commit is contained in:
Oleg Zhurakousky
2021-05-25 14:53:08 +02:00
parent 2677035779
commit 70537b924e
3 changed files with 10 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.adoc
View File

@@ -175,13 +175,14 @@ You can also build and package your application into a boot jar (by using `./mvn
Now you have a working (albeit very basic) Spring Cloud Stream application.
== What's New in 3.0?
== What's New in 3.x?
[[spring-cloud-stream-preface-new-features]]
=== New Features and Enhancements
- *Routing Function* - see <<Routing with functions>> for more details.
- *Routing Function* - see <<Event Routing>> for more details.
- *StreamBridge* - for dynamic destinations. See <<Sending arbitrary data to an output (e.g. Foreign event-driven sources)>> for more details.
- *Multiple bindings with functions* (multiple message handlers) - see <<Multiple functions in a single application>> for more details.
- *Functions with multiple inputs/outputs* (single function that can subscribe or target multiple destinations) - see <<Functions with multiple input and output arguments>> for more details.
- *Native support for reactive programming* - since v3.0.0 we no longer distribute spring-cloud-stream-reactive modules and instead
@@ -192,6 +193,8 @@ compatibility you can still bring `spring-cloud-stream-reactive` from previous v
[[spring-cloud-stream-preface-notable-deprecations]]
=== Notable Deprecations
- Annotation-based programming model. Basically the @EnableBInding, @StreamListener and all related annotations are now deprecated in
favor of the functional programming model. See <<Spring Cloud Function support>> for more details.
- _Reactive module_ (`spring-cloud-stream-reactive`) is discontinued and no longer distributed in favor of native support via spring-cloud-function.
For backward
compatibility you can still bring `spring-cloud-stream-reactive` from previous versions.

7
docs/src/main/asciidoc/preface.adoc
View File

@@ -154,13 +154,14 @@ You can also build and package your application into a boot jar (by using `./mvn
Now you have a working (albeit very basic) Spring Cloud Stream application.
== What's New in 3.0?
== What's New in 3.x?
[[spring-cloud-stream-preface-new-features]]
=== New Features and Enhancements
- *Routing Function* - see <<Routing with functions>> for more details.
- *Routing Function* - see <<Event Routing>> for more details.
- *StreamBridge* - for dynamic destinations. See <<Sending arbitrary data to an output (e.g. Foreign event-driven sources)>> for more details.
- *Multiple bindings with functions* (multiple message handlers) - see <<Multiple functions in a single application>> for more details.
- *Functions with multiple inputs/outputs* (single function that can subscribe or target multiple destinations) - see <<Functions with multiple input and output arguments>> for more details.
- *Native support for reactive programming* - since v3.0.0 we no longer distribute spring-cloud-stream-reactive modules and instead
@@ -171,6 +172,8 @@ compatibility you can still bring `spring-cloud-stream-reactive` from previous v
[[spring-cloud-stream-preface-notable-deprecations]]
=== Notable Deprecations
- Annotation-based programming model. Basically the @EnableBInding, @StreamListener and all related annotations are now deprecated in
favor of the functional programming model. See <<Spring Cloud Function support>> for more details.
- _Reactive module_ (`spring-cloud-stream-reactive`) is discontinued and no longer distributed in favor of native support via spring-cloud-function.
For backward
compatibility you can still bring `spring-cloud-stream-reactive` from previous versions.

22
docs/src/main/asciidoc/spring-cloud-stream.adoc
View File

@@ -335,28 +335,6 @@ where you are clearly correlating the input of `uppercase` function to `sample-t
For more on properties and other configuration options please see <<Configuration Options>> section.
*Pollable Destination Binding*
While the previously described bindings support event-based message consumption, sometimes you need more control, such as rate of consumption.
Starting with version 2.0, you can now bind a pollable consumer:
The following example shows how to bind a pollable consumer:
[source, java]
----
public interface PolledBarista {
@Input
PollableMessageSource orders();
. . .
}
----
In this case, an implementation of `PollableMessageSource` is bound to the `orders` “channel”. See <<Using Polled Consumers>> for more details.
[[spring-cloud-stream-overview-producing-consuming-messages]]
=== Producing and Consuming Messages