Moves state diagram to docs folder

bloomberg · Jan 12, 2024 · 98b3ed9 · 98b3ed9
1 parent 308e8d9
commit 98b3ed9
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/consumer-state-diagram.md b/docs/consumer-state-diagram.md
@@ -0,0 +1,11 @@
+# Consumer states
+
+The diagram shows the state changes based on the Broker messages we receive.
+
+## `CANCELLING_BUT_RESUMING`
+
+New state `CANCELLING_BUT_RESUMING` was added to support resume after cancellation. 
+
+- calling `resume()` in a `CANCELLING` state sets the state to `CANCELLING_BUT_RESUMING` which will enable consumer restart
+
+- previously cancelled consumer would be restarted after `resume()` call
diff --git a/examples/resume/README.md b/examples/resume/README.md