potential new callback sig

readme.md
rabbitmq · Feb 7, 2024 · ff53c03 · ff53c03
1 parent 985dfe4
commit ff53c03
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -440,7 +440,7 @@ Ra attempts to follow [Semantic Versioning](https://semver.org/).
 
 The modules that form part of the public API are:
 * `ra`
-* `ra_machine`
+* `ra_machine` (behaviour callbacks only)
 * `ra_system`
 * `ra_counters`
 * `ra_leaderboard`

diff --git a/src/ra_machine.erl b/src/ra_machine.erl
@@ -232,6 +232,20 @@
 
 -callback init_aux(Name :: atom()) -> term().
 
+-callback handle_aux(ra_server:ra_state(),
+                     {call, From :: from()} | cast,
+                     Command :: term(),
+                     AuxState,
+                     State) ->
+    {reply, Reply :: term(), AuxState, State} |
+    {reply, Reply :: term(), AuxState, State,
+     [{monitor, process, aux, pid()}]} |
+    {no_reply, AuxState, State} |
+    {no_reply, AuxState, State,
+     [{monitor, process, aux, pid()}]}
+      when AuxState :: term(),
+           State :: ra_aux:state().
+
 -callback handle_aux(ra_server:ra_state(),
                      {call, From :: from()} | cast,
                      Command :: term(),