Update samples link in doc

This commit is contained in:
Ilayaperumal Gopinathan
2016-02-25 20:14:55 +05:30
committed by Marius Bogoevici
parent 5e2e4ecd67
commit d7c73fff00
4 changed files with 14 additions and 31 deletions

View File

@@ -85,6 +85,10 @@ For an XD module the channel names are `<group>.<index>` and a source (output on
> Note: since the same naming conventions are used in XD, you can steal messages from or send messages to an existing XD stream by copying the stream name (to `spring.cloud.stream.<channelName>.group`) and knowing the index of the XD module you want to interact with.
=== Samples
For Spring Cloud Stream samples, please refer: https://github.com/spring-cloud/spring-cloud-stream-samples
=== Contributing
// TODO point to ref doc section

View File

@@ -7,12 +7,12 @@ Sabby Anandan, Marius Bogoevici, Eric Bottard, Mark Fisher, Ilayaperumal Gopinat
:numbered:
:icons: font
:hide-uri-scheme:
:spring-cloud-dataflow-repo: snapshot
:spring-cloud-stream-repo: snapshot
:github-tag: master
:spring-cloud-dataflow-docs-version: current
:spring-cloud-dataflow-docs: http://docs.spring.io/spring-cloud-dataflow/docs/{spring-cloud-dataflow-docs-version}/reference
:spring-cloud-dataflow-docs-current: http://docs.spring.io/spring-cloud-dataflow/docs/current-SNAPSHOT/reference/html/
:github-repo: spring-projects/spring-cloud-dataflow
:spring-cloud-stream-docs-version: current
:spring-cloud-stream-docs: http://docs.spring.io/spring-cloud-stream/docs/{spring-cloud-stream-docs-version}/reference
:spring-cloud-stream-docs-current: http://docs.spring.io/spring-cloud-stream/docs/current-SNAPSHOT/reference/html/
:github-repo: spring-cloud/spring-cloud-stream
:github-raw: http://raw.github.com/{github-repo}/{github-tag}
:github-code: http://github.com/{github-repo}/tree/{github-tag}
:github-wiki: http://github.com/{github-repo}/wiki
@@ -20,7 +20,7 @@ Sabby Anandan, Marius Bogoevici, Eric Bottard, Mark Fisher, Ilayaperumal Gopinat
:sc-ext: java
:sc-spring-boot: {github-code}/spring-boot/src/main/java/org/springframework/boot
:dc-ext: html
:dc-root: http://docs.spring.io/spring-cloud-dataflow/docs/{spring-cloud-dataflow-docs-version}/api
:dc-root: http://docs.spring.io/spring-cloud-stream/docs/{spring-cloud-stream-docs-version}/api
:dc-spring-boot: {dc-root}/org/springframework/boot
:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin
:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md
@@ -41,8 +41,6 @@ Sabby Anandan, Marius Bogoevici, Eric Bottard, Mark Fisher, Ilayaperumal Gopinat
= Reference Guide
include::spring-cloud-stream-overview.adoc[]
= Samples
include::spring-cloud-stream-samples.adoc[]
= Appendices
[appendix]

View File

@@ -367,3 +367,7 @@ The Redis Binder creates a `LIST` (which performs the role of a queue) for each
trigger `BRPOP` operations on its group's `LIST`. A producer binding will consult a `ZSET` to determine what groups
currently have active consumers, and then for each message being sent, an `LPUSH` operation will be executed on each of
those group's `LISTs`.
=== Samples
For Spring Cloud Stream samples, please refer: https://github.com/spring-cloud/spring-cloud-stream-samples

View File

@@ -1,23 +0,0 @@
[[spring-cloud-stream-samples]]
== Sample Applications
There are several samples, all running on the redis transport (so you need redis running locally to test them).
* `source` is a Java config version of the classic "timer" module from Spring XD. It has a "fixedDelay" option (in milliseconds) for the period between emitting messages.
* `sink` is a Java config version of the classic "log" module from Spring XD. It has no options (but some could easily be added), and just logs incoming messages at INFO level.
* `transform` is a simple pass through logging transformer (just logs the incoming message and passes it on).
* `double` is a combination of 2 modules defined locally (a source and a sink, so the whole app is self contained).
* `extended` is a multi-module mashup of `source | transform | transform | sink`, where the modules are defined in the other samples and referred to in this app just as dependencies.
* `multibinder` is a sample application that shows how an application could use multiple binders. In this case, the processor's input/output channels connect to different brokers using their own binder configurations.
* `multibinder-differentsystems` shows how an application could use same binder implementation but different configurations for its channels. In this case, a processor's input/output channels connect to same binder implementation but with two separate broker configurations.
If you run the source and the sink and point them at the same redis instance (e.g. do nothing to get the one on localhost, or the one they are both bound to as a service on Cloud Foundry) then they will form a "stream" and start talking to each other. All the samples have friendly JMX and Actuator endpoints for inspecting what is going on in the system.