doc: document shutdown plugin.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
ElementsProject · Sep 3, 2021 · 1e3d90b · 1e3d90b
1 parent fe4cee1
commit 1e3d90b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/doc/PLUGINS.md b/doc/PLUGINS.md
@@ -791,6 +791,16 @@ here, with the peer's signatures attached.
 }
 ```
 
+### `shutdown`
+
+Called when lightningd is shutting down, or this plugin has been
+shutdown by the plugin stop command.  The plugin has 30 seconds to
+exit itself, otherwise it's killed.
+
+Because lightningd can crash or be killed, a plugin cannot rely on
+this function always called.
+
+
 ## Hooks
 
 Hooks allow a plugin to define custom behavior for `lightningd`