Spring/spring-statemachine
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs changes

Browse Source 
- Relates #742
This commit is contained in:
Janne Valkealahti
2019-08-04 08:04:05 +01:00
parent 7fac746298
commit 96773828fc
4 changed files with 68 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/src/reference/asciidoc/appendix-reactormigration-communicating.adoc
View File

@@ -11,7 +11,8 @@ include::samples/DocsMigrationTests.java[tags=snippetA]
We're now solely working on a spring `Message` and reactor `Mono` and `Flux` classes.
You can send a `Mono` of a `Message` and receive back a `Flux` of `StateMachineEventResult`.
Remember that nothing happens until you subscribe to this `Flux`.
Remember that nothing happens until you subscribe to this `Flux`. More about
this returned value, see <<sm-triggers-statemachineeventresult>>.
====
[source,java,indent=0]
@@ -38,3 +39,13 @@ do something when event handling is completed, you could do something like.
include::samples/DocsMigrationTests.java[tags=snippetB3]
----
====
Old API methods returning a `boolean` for accepted status are still in place
but are deprecated to get removed in future releases.
====
[source,java,indent=0]
----
include::samples/DocsMigrationTests.java[tags=snippetB4]
----
====

33
docs/src/reference/asciidoc/sm-triggers.adoc
View File

@@ -20,13 +20,13 @@ include::samples/DocsConfigurationSampleTests.java[tags=snippetO]
----
====
The preceding example sends an event two different ways. First, it
sends a type-safe event by using the state machine API method called
`sendEvent(E event)`. Second, it sends an event wrapped in a Spring
messaging `Message` by using the API method called `sendEvent(Message<E> message)`
with a custom event headers. This lets us add arbitrary extra
information to an event, which is then visible to `StateContext` when
(for example) you implement actions.
IMPORTANT: Nothing happens until returned flux is subscribed. See more about it from
<<sm-triggers-statemachineeventresult>>.
The preceding example sends an events by constructing a `Mono` wrapping
a `Message` and subscribing into returned `Flux` of results. `Message` lets
us add arbitrary extra information to an event, which is then visible
to `StateContext` when (for example) you implement actions.
NOTE: Message headers are generally passed on until machine runs to
completion for a specific event. For example if an event is causing
@@ -34,6 +34,25 @@ transition into a state `A` which have an anonymous transition into a
state `B`, original event is available for actions or guards in state
`B`.
It is also possible to send a `Flux` of messages instead of sending just
one with a `Mono`.
====
[source,java,indent=0]
----
include::samples/DocsConfigurationSampleTests.java[tags=snippetO2]
----
====
[[sm-triggers-statemachineeventresult]]
==== StateMachineEventResult
`StateMachineEventResult` contains more detailed information about a result
of a event sending. From this you can get a `Region` which handled an event,
`Message` itself and what was an actual `ResultType`. From `ResultType` you
can see if message was accepted, denied or deferred. Generally speaking when
subscribtion completes, events are passed into a machine.
=== Using `TimerTrigger`
`TimerTrigger` is useful when something needs to be triggered