diff options
| author | Florent Le Coz <louiz@louiz.org> | 2014-01-04 02:04:38 +0100 |
|---|---|---|
| committer | Florent Le Coz <louiz@louiz.org> | 2014-01-04 02:04:38 +0100 |
| commit | b51368304140ea227dbbb71357a2fe9d7fd9057a (patch) | |
| tree | bb3937a9fd7088f283f877ff897e8eb4900bdf2b | |
| parent | d90c1978def803390203f0fada3621de8abba0e5 (diff) | |
| download | biboumi-b51368304140ea227dbbb71357a2fe9d7fd9057a.tar.gz biboumi-b51368304140ea227dbbb71357a2fe9d7fd9057a.tar.bz2 biboumi-b51368304140ea227dbbb71357a2fe9d7fd9057a.tar.xz biboumi-b51368304140ea227dbbb71357a2fe9d7fd9057a.zip | |
Document the shutdown procedure
| -rw-r--r-- | doc/biboumi.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/biboumi.md b/doc/biboumi.md index 35755ef..4bbbcf7 100644 --- a/doc/biboumi.md +++ b/doc/biboumi.md @@ -73,6 +73,14 @@ the same IRC connection is used. If, however, an other user wants to join an IRC channel on that same IRC server, biboumi opens a new connection to that server. Biboumi connects once to each IRC server, for each user on it. +To cleanly shutdown the component, send the SIGINT or SIGTERM signals to it. +It will send messages to all connected IRC and XMPP servers to indicate a +reason why the users are being disconnected. Biboumi exits when all +connections are closed because the remote aknowledged the end of +communication. If the remote server does not respond, biboumi does not +exit, unless SIGINT or SIGTERM is received again, in which case biboumi +closes the TCP connections and exits immediately. + ### Addressing IRC entities are represented by XMPP JIDs. The domain part of the JID is |