mod_s2s: Comment on the various 'reason' arguments passed to :close

author: Kim Alvefur <zash@zash.se>
date: Sun, 26 Jan 2020 19:52:48 +0100
parent: 10625:3bfb20be844c
child: 10648:2bd17e043275
--- a/plugins/mod_s2s/mod_s2s.lua	Sun Jan 26 16:55:28 2020 +0100
+++ b/plugins/mod_s2s/mod_s2s.lua	Sun Jan 26 19:52:48 2020 +0100
@@ -487,6 +487,9 @@
 
 --- Session methods
 local stream_xmlns_attr = {xmlns='urn:ietf:params:xml:ns:xmpp-streams'};
+-- reason: stream error to send to the remote server
+-- remote_reason: stream error received from the remote server
+-- bounce_reason: stanza error to pass to bounce_sendq beacuse stream- and stanza errors are different
 local function session_close(session, reason, remote_reason, bounce_reason)
 	local log = session.log or log;
 	if session.conn then