view mod_graceful_shutdown/README.markdown @ 4983:7c77058a1ac5

mod_compat_roles: New module providing compat shim for trunk's new role API The new role API is translated to is_admin() calls on older versions. On newer versions (which have the role API) this module does nothing. It allows modules to drop their use of is_admin() (which is not available in trunk) and switch to the new role API, while remaining compatible with previous Prosody versions.
author Matthew Wild <mwild1@gmail.com>
date Thu, 11 Aug 2022 17:49:33 +0100
parents 999e7cb7f6d9
children
line wrap: on
line source

::: {.alert .alert-warning}
This module is an experiment about a more graceful shutdown process.

Graceful shutdown has now been implemented in Prosody trunk and will be
part 0.12. See [issue #1225](https://issues.prosody.im/1225) for
details.
:::

Why
===

When shutting down, a number of sessions, connections and other things
are teared down. Due to all these things happening very quickly,
sometimes e.g. client unavailable notifications don't make it to all
remote contacts because the server-to-server connections are teared down
just after.

How
===

This module works by breaking the shutdown process into separate steps
with a brief pause between them.

It goes something like this

1.  Stop accepting new client connections.
2.  Close all client connections.
3.  Fire event for everything else.
4.  Tell `net.server` to quit the main loop.
5.  ???
6.  Still here? Kill itself.