From b51368304140ea227dbbb71357a2fe9d7fd9057a Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Sat, 4 Jan 2014 02:04:38 +0100 Subject: Document the shutdown procedure --- doc/biboumi.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'doc') 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 -- cgit v1.2.3