From b7fc7fdada4019da3527b8870e300c88239e0600 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20R=C3=A9mond?= Date: Fri, 22 Sep 2006 09:09:28 +0000 Subject: * doc/guide.tex: Large improvements for ejabberd 1.1.2 (thanks to Sander Devrieze) * doc/version.tex: Likewise. * doc/features.tex: Likewise. * doc/Makefile: Likewise. * doc/dev.tex: Likewise. SVN Revision: 617 --- doc/dev.html | 79 +++++++++++++++++++++++++++--------------------------------- 1 file changed, 35 insertions(+), 44 deletions(-) (limited to 'doc/dev.html') diff --git a/doc/dev.html b/doc/dev.html index 8681b1521..6cb4d2a46 100644 --- a/doc/dev.html +++ b/doc/dev.html @@ -4,7 +4,7 @@ -Ejabberd 1.1.1 Developers Guide +Ejabberd 1.1.2 Developers Guide @@ -22,7 +22,7 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} - + @@ -34,7 +34,7 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} @@ -42,7 +42,7 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
- + logo.png
@@ -61,49 +61,50 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} 1.1  Key Features
  • 1.2  Additional Features -
  • 2  How it works +
  • 2  How it Works -
  • 3  XML representation +
  • 3  XML Representation
  • 4  Module xml
  • 5  Module xml_stream -
  • 6  ejabberd modules +
  • 6  Modules -

    1  Introduction

    +

    1  Introduction

    - + -ejabberd is a free (GPL) distributed fault-tolerant Jabber/XMPP server and is mainly written in Erlang.
    +ejabberd is a free and open source instant messaging server written in Erlang.

    -ejabberd is designed to be a stable, standards compliant, and feature rich Jabber/XMPP server.
    +ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

    -ejabberd is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers.
    +ejabberd is designed to be a rock-solid and feature rich XMPP server.
    +
    +ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.

    -

    1.1  Key Features

    +

    1.1  Key Features

    ejabberd is:
    • -Multiplatform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
      +Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.

    • Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.

      -
    • Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced “on the fly”.
      +
    • Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.

    • Administrator Friendly: ejabberd is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
      • @@ -124,17 +125,17 @@ Translated in 11 languages.
      • Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
        • -Fully XMPP compliant -
        • XML-based protocol +Fully XMPP compliant. +
        • XML-based protocol.
        • Many JEPs supported.
      -

      1.2  Additional Features

      +

      1.2  Additional Features

      -Besides common Jabber server features, ejabberd comes with a wide range of other features: +Moreover, ejabberd comes with a wide range of other state-of-the-art features:
      • Modular
        • @@ -152,12 +153,12 @@ SASL and STARTTLS for c2s and s2s connections. Native MySQL support.
        • Native PostgreSQL support.
        • Mnesia. -
        • ODBC data storage support. -
        • Microsoft SQL Server support (via ODBC). +
        • ODBC data storage support. +
        • Microsoft SQL Server support.
      • Authentication
        • -LDAP and ODBC. +LDAP and ODBC.
        • External Authentication script.
        • Internal Authentication.
        @@ -170,14 +171,14 @@ Compressing XML streams with Stream Compression (Multi-User Chat module with logging.
      • Users Directory based on users vCards.
      • Publish-Subscribe component. -
      • Support for virtual hosting. +
      • Support for virtual hosting.
      • HTTP Polling service.
      • IRC transport.
    - + -

    2  How it works

    +

    2  How it Works

    A Jabber domain is served by one or more ejabberd nodes. These nodes can @@ -235,9 +236,9 @@ routes the packet to S2S manager on that node, if it is open on this node, then it is routed to the process that serves this connection, and if a connection does not exist, then it is opened and registered.

    - + -

    3  XML representation

    +

    3  XML Representation

    Each XML stanza is represented as the following tuple: @@ -325,21 +326,14 @@ Err = term() Parses Str using XML parser, returns either parsed element or error tuple. - + -

    6  ejabberd modules

    +

    6  Modules

    - - -

    6.1  gen_mod behaviour

    - - -TBD
    -
    -

    6.2  Module gen_iq_handler

    +

    6.1  Module gen_iq_handler

    The module gen_iq_handler allows to easily write handlers for IQ packets @@ -408,12 +402,9 @@ process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) -> -

    6.3  Services

    +

    6.2  Services

    -TBD
    -
    -TODO: use proc_lib
     -module(mod_echo).
     
    -- 
    cgit v1.2.3
    
    
  • -

    Ejabberd 1.1.1 Developers Guide

    +

    Ejabberd 1.1.2 Developers Guide

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