Add turnstile reactive docs

- Relates #742
This commit is contained in:
Janne Valkealahti
2019-05-17 16:04:20 +01:00
parent 345b27b2b2
commit efbd72b4d1
6 changed files with 237 additions and 18 deletions

View File

@@ -0,0 +1,123 @@
[[statemachine-examples-turnstilereactive]]
== Turnstile Reactive
Turnstile reactive is an enhacement to <<statemachine-examples-turnstile>> sample using
same _StateMachine_ concept and adding a reactive web layer communicating reactively with
a _StateMachine_ reactive interfaces.
`StateMachineController` is a simple `@RestController` where we autowire our `StateMachine`.
====
[source,java,indent=0]
----
include::samples/demo/turnstilereactive/StateMachineController.java[tags=snippetA]
----
====
We create first mapping to return a machine state. As state doesn't come out from
a machine reactively, we can _defer_ it so that when a returned `Mono` is subscribed,
actual state is requested.
====
[source,java,indent=0]
----
include::samples/demo/turnstilereactive/StateMachineController.java[tags=snippetB]
----
====
To send a single event or multiple events to a machine we can use a `Flux` in both
incoming and outgoing layers. `EventResult` here is just for this sample and simply
wraps `ResultType` and event.
====
[source,java,indent=0]
----
include::samples/demo/turnstilereactive/StateMachineController.java[tags=snippetC]
----
====
You can use the following command to run the sample:
====
[source,text,subs="verbatim,attributes"]
----
$ java -jar spring-statemachine-samples-turnstilereactive-{revnumber}.jar
----
====
Example of getting a state:
====
[source,bash]
----
GET http://localhost:8080/state
----
====
Would then response:
====
[source,text]
----
"LOCKED"
----
====
Example of sending an event:
====
[source,bash]
----
POST http://localhost:8080/events
content-type: application/json
{
"event": "COIN"
}
----
====
Would then response:
====
[source,json]
----
[
{
"event": "COIN",
"resultType": "ACCEPTED"
}
]
----
====
You can post multiple events:
====
[source,bash]
----
POST http://localhost:8080/events
content-type: application/json
[
{
"event": "COIN"
},
{
"event": "PUSH"
}
]
----
====
Response then contains results for both events:
====
[source,json]
----
[
{
"event": "COIN",
"resultType": "ACCEPTED"
},
{
"event": "PUSH",
"resultType": "ACCEPTED"
}
]
----
====

View File

@@ -12,6 +12,8 @@ normal build cycle. This chapter includes the following samples:
<<statemachine-examples-turnstile>>
<<statemachine-examples-turnstilereactive>>
<<statemachine-examples-showcase>>
<<statemachine-examples-cdplayer>>
@@ -63,6 +65,7 @@ build of this document, meaning that, if you build samples from
master, you have files with a `BUILD-SNAPSHOT` postfix.
include::sm-examples-turnstile.adoc[]
include::sm-examples-turnstilereactive.adoc[]
include::sm-examples-showcase.adoc[]
include::sm-examples-cdplayer.adoc[]
include::sm-examples-tasks.adoc[]