From 2aa3c1c7208823fedc77e7c8d1a50d2012676e78 Mon Sep 17 00:00:00 2001 From: Alexey Shchepin Date: Fri, 24 Jan 2003 20:18:33 +0000 Subject: *** empty log message *** SVN Revision: 49 --- doc/guide.html | 95 +++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 67 insertions(+), 28 deletions(-) (limited to 'doc/guide.html') diff --git a/doc/guide.html b/doc/guide.html index a8ff887a..f724f4be 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -18,7 +18,10 @@

Alexey Shchepin
mailto:alexey@sevcom.net
xmpp:aleksey@jabber.ru

January 23, 2003

-
+ +
+
+

@@ -90,9 +93,7 @@ values.
serves. E. g. to use jabber.org domain add following line in config: 
 {host, "jabber.org"}.
-
This option is mandatory.
-
- +

3.1.2   Listened Sockets

@@ -143,28 +144,30 @@ section 5 for detailed information on each modul Example: 
 {modules, [
-           {mod_register,  [one_queue]},
-           {mod_roster,    [one_queue]},
-           {mod_configure, [one_queue]},
-           {mod_disco,     [one_queue]},
-           {mod_stats,     [one_queue]},
-           {mod_vcard,     [one_queue]},
+           {mod_register,  []},
+           {mod_roster,    []},
+           {mod_configure, []},
+           {mod_disco,     []},
+           {mod_stats,     []},
+           {mod_vcard,     []},
            {mod_offline,   []},
-           {mod_echo,      []},
-           {mod_private,   [one_queue]},
-           {mod_time,      [one_queue]},
-           {mod_version,   [one_queue]}
+           {mod_echo,      [{host, "echo.e.localhost"}]},
+           {mod_private,   []},
+           {mod_time,      [{pdisc, no_queue}]},
+           {mod_version,   []}
           ]}.

3.2   Online Configuration

To use facility of online reconfiguration of ejabberd needed to have -mod_configure loaded (section 5.3). Also highly -recommended to load mod_disco (section 5.4), because +mod_configure loaded (see section 5.4). Also highly +recommended to load mod_disco (see section 5.5), because mod_configure highly integrates with it. Also recommended to use disco-capable client.

+TBD
+

4   Distribution

@@ -173,49 +176,85 @@ disco-capable client.

5   Built-in Modules

- + + +

5.1   Common Options

+ +Following options used by many modules, so they described in separate section.
+
+ + +

5.1.1   Option iqdisc

+Many modules define handlers for processing IQ queries of different namespaces +to this server or to user (e. g. to myjabber.org or to +user@myjabber.org). This option defines processing discipline of this +queries. Possible values are: +
+
+no_queue
All queries of namespace with this processing + discipline processed immediately. This also means that no other packets can + be processed until finished this. Hence this discipline is not recommended + if processing of query can take relative many time. + +
one_queue
In this case created separate queue for processing + IQ queries of namespace with this discipline, and processing of this queue + done in parallel with processing of other packets. This discipline is most + recommended. + +
parallel
In this case for all packets of namespace with this + discipline spawned separate Erlang process, so all this packets processed in + parallel. Although spawning of Erlang process have relative low cost, this + can broke server normal work, because Erlang have limit of 32000 processes. +
Example: +
+{modules, [
+           ...
+           {mod_time,      [{pdisc, no_queue}]},
+           ...
+          ]}.
+
-

5.1   mod_register

+

5.2   mod_register

-

5.2   mod_roster

+

5.3   mod_roster

-

5.3   mod_configure

+

5.4   mod_configure

-

5.4   mod_disco

+

5.5   mod_disco

-

5.5   mod_stats

+

5.6   mod_stats

-

5.6   mod_vcard

+

5.7   mod_vcard

-

5.7   mod_offline

+

5.8   mod_offline

-

5.8   mod_echo

+

5.9   mod_echo

-

5.9   mod_private

+

5.10   mod_private

-

5.10   mod_time

+

5.11   mod_time

-

5.11   mod_version

+

5.12   mod_version

-- cgit v1.2.3