Update to current module set for 4.0
authorOlle E. Johansson <oej@edvina.net>
Fri, 18 Jan 2013 08:41:42 +0000 (09:41 +0100)
committerOlle E. Johansson <oej@edvina.net>
Fri, 18 Jan 2013 08:41:42 +0000 (09:41 +0100)
README-MODULES

index e04c872..7c96b19 100644 (file)
@@ -3,7 +3,7 @@
 SIP-ROUTER modules
 ==================
 
-This is the first release of the merged product - Kamailio and SER. 
+This is the second major release of the merged SIP Server - Kamailio and SER. 
 In the previous release some modules where provided in two versions, in Kamailio
 and SER flavours. These are now merged. In some cases, the functionality has 
 changed. You can still do the same operation, but how you do it may be different.
@@ -30,49 +30,108 @@ A single module may provide a selection of this, maybe only one of them.
 
 Core modules
 ------------
+app_lua                        Execute embedded LUA scripts
+app_mono               Execute embedded MONO scripts (like C#, Java, javascript)
+app_python             Execute embedded Python scripts
+async                  Asynchronus SIP request handling functions
+auth                   MD5 digest authentication support
 auth_identity          SIP Identity support (RFC 4474)
 auth_radius            Radius authentication
+acp                    Collection of functions for handling AVP's (from SER)
 avpops                 Attribute-value pair operations ("variables")
 carrierroute           A telephony routing module
+blst                   Blacklisting API for configuration scripts
+cdp                    C Diameter Peer - core communication engine
+cdp_avp                        C Diameter Peer - application extensions
 cfg_db                 Database driver for configuration API
-cfg_rpc
-ctl
+cfg_rpc                        Update core and module parameters from RPC
+corex                  Core extensions
+counters               Internal counter API for configuration
+ctl                    Control connector for RPC interface (fifo, unixsock, tcp, udp)
 db_berkeley            Database :: Berkeley DB (Oracle)
+db_cassandra           Cassandra database server connector
 db_flatstore           Database :: Flatstore
 db_mysql               Database :: Mysql
 db_postgres            Database :: PostgreSQL
+db2_ldap               Database connector to LDAP using the DB2 API
+db2_ops                        Database operations for DB API v2
+debugger               Interactive configuration processing debugger
 dialplan               Dialplan management
+dialog_ng              Dialog tracking module - next generation
 enum                   Enum support
+geoip                  GeoIP API to configuration file
+ims_auth               IMS authentication module
+ims_icscf              IMS ICSCF component module
+ims_isc                        IMS ISC component module
+ims_qos                        IMS Diameter Rx interface
+ims_registrar_pcscf    IMS PCSCF registrar module
+ims_registrar_scscf    IMS SCSCF registrar module
+ipops                  IP and DNS related operations
 iptrtpproxy            NAT traversal :: Kernel based RTP proxy
+json                   Access to JSON document attributes
+jsonrpc-c              JSON-RPC client over netstrings protocol
 lcr                    Least cost routing
+malloc_test            Functions for stress-testing memory manager (from SER)
+mangler                        SIP message mangling functions (from SER)
+matrix                 Matrix operations
 mediaproxy             Nat traversal :: Mediaproxy (AG projects)
 mi_rpc                 Management Interface :: XML RPC support
 misc_radius            Various Radius functions
+msrp                   Embedded MSRP relay (RFC 4975 and RFC 4976)
+ndb_redis              Connector to REDIS NoSQL Database engine
 pdb                    Number portabilityusing external server
 peering                        SIP peering between service providers
+pipelimit              Traffic shaping policies
+prefix_route           Execute config file route blocks based on prefix
+print                  DEVEL :: Basic sample of a module
+print_lib              DEVEL :: Basic sample of a module with dependency on other modules
+ratelimit              Traffic shaping module
+rtpproxy               NAT :: Nat traversal module for RTPproxy control
+sanity                 Syntax checking for incoming SIP requests
+sca                    PRESENCE :: Shared call appearances
+sdpops                 SDP operations
+sipcapture             SIP Capture Server module (used in the Homer project)
+sl                     Proxy :: Stateless handling of SIP messages
+sms                    SMS gateway support
+textopsx               Extra Text operations
+timer                  Execute routing blocks on core timers (From SER)
 tls                    SSL/TLS support
-tm                     SIP transaction support (stateful proxy)
+tm                     Proxy :: SIP transaction support (stateful)
 topoh                  Topology hinding
+uid_auth_db            Authentication module using unique IDs (from SER)
+uid_avp_db             AVP Database operations using unique IDs (from SER)
+uid_domain             Domain management using unique IDs (from SER)
+uid_gflags             Global attributes and flags using Unique IDs (from SER)
+uid_uri_db             Database URI operations using unique IDs (from SER)
 utils                  Various utilities (http query, xcap status)
-xmlrpc
+websocket              HTTP :: Websocket transport layer for proxy
+xhttp                  HTTP :: The server
+xhttp_pi               HTTP :: Provisioning interface for Kamailio
+xhttp_rpc              HTTP :: RPC Command support
+xlog                   Utils :: Extended logging support
+xmlops                 XML operations using XPath
+xmlrpc                 HTTP :: XMLrpc support
+xprint                 Functions for printing messages with specifiers (from SER)
 
 Kamailio modules
 ----------------
 acc                    Accounting
+acc_radius             Accounting with RADIUS backend
 alias_db               Alias management in database modules
-auth                   MD5 digest authentication support
 auth_db                        Authentication using a database module
 auth_diameter          Authentication based on Diameter
 benchmark              Development benchmark module
 call_control           Call timeouts and management (depends on Dialog module)
 cfgutils               Various configuration utilities
 cpl-c                  Implementation of SIP Call Processing Language (RFC 3880)
+db_cluster             Generic database connectors clustering and failover
 db_oracle              Database :: Oracle support
 db_text                        Database :: Text support
 db_unixodbc            Database :: Unix ODBC support
 dialog                 Dialog ("call") state module
 dispatcher             Load balancing and failover
 diversion              Call redirect support (SIP Diversion: header)
+dmq                    Devel :: Distributed message queue system using SIP (early development)
 domain                 Proxy :: Multiple domain support using databases
 domainpolicy           Proxy :: Obsolete module - This module is no longer maintained
 drouting               Proxy :: Dynamic routing
@@ -89,10 +148,13 @@ memcached          Utils :: In-memory caching support (memcached)
 mi_datagram            Management interface :: UDP
 mi_fifo                        Management Interface :: Unix FIFO
 mi_xmlrpc              Management Interface :: XML-rpc
+mqueue                 Message queue system for configuration file
 msilo                  Text message storage
 nat_traversal          NAT :: NAT traversal module
 nathelper              NAT :: NAT traversal module :: RTPproxy (SIPPY software)
 osp                    Open Settlement Protocol support
+outbound               SIP Outbound Implementation
+p_usrloc               Partitioned and distributed user location services
 path                   Path: header support
 pdt                    Proxy :: Routing based on numeric prefix
 perl                   Perl-based module interface
@@ -100,13 +162,17 @@ perlvdb                   Database :: Use perl database functions
 permissions            Security :: TCP-wrapper-like ACL functions
 pike                   Security :: DOS-attack prevention
 presence               Presence :: Core presence module
+presence_conference    Presence :: Conference events handling
 presence_dialoginfo    Presence :: Dialog info
 presence_mwi           Presence :: Message waiting indication
+presence_profile       Presence :: User profile extensions (RFC 6080)
+presence_reginfo       Presence :: Registration info (RFC 3680)
 presence_xml           Presence :: XML handler
 pua                    Presence :: Common module
 pua_bla                        Presence :: BLA
 pua_dialoginfo         Presence :: Dialog Info support
 pua_mi                 Presence :: Management interface
+pua_reginfo            Presence :: Registration information (RFC 3680)
 pua_usrloc             Presence :: USRLOC integration
 pua_xmpp               Presence :: XMPP/Jabber gateway
 purple                 Presence :: Libpurple support
@@ -118,12 +184,9 @@ registrar          Registrar/location server support
 rls                    Presence :: Resource list server
 rr                     Proxy :: Record routing
 rtimer                 Utils :: Timer based routing script processing
-sanity                 Syntax checking for incoming SIP requests
 seas                   Application server interface
 siptrace               Store SIP messages in database
 siputils               Various utilities for SIP call handling
-sl                     Proxy :: Stateless handling of SIP messages
-sms                    SMS gateway support
 snmpstats              SNMP support (net-snmp agentx)
 speeddial              Per-user speed-dial controller module
 sqlops                 SQL operations
@@ -137,64 +200,5 @@ uri_db                     URI operation with database support
 userblacklist          User-specific blacklists
 usrloc                 Proxy :: Location server
 xcap_client            Presence :: XCAP support
-xlog                   Utils :: Extended logging support
+xcap_server            Presence :: XCAP server implementation
 xmpp                   Presence/IM :: XMPP/jabber gateway
-
-SER modules
------------
-acc_db                 Authentication :: acc module is used to report on transactions to database
-acc_radius             Authentication :: acc module is used to report on transactions to RADIUS.
-acc_syslog             Authentication :: acc module is used to report on transactions to syslog
-auth                   Authentication backend (needs additional modules)
-auth_db                        Database authentication
-avp                    functions used to manipulate the contents of Attribute-Value pairs
-avp_db                 Attribute-value pairs in database
-bdb                    Database :: Berkeley DB (Oracle)
-blst                   Blacklist management
-cpl-c                  CPL support in SIP-router
-db_ops                 Database :: SQL operations from configurtion script
-dbg                    Debugging support
-dbtext                 Database :: Text
-dialog
-dispatcher             Load balancing ::  a dispatcher for destination addresses
-diversion              Proxy :: Call redirection support (Diversion: header)
-domain                 Proxy :: Multiple domain support
-eval                   implements expression evaluation in route script
-exec                   Proxy :: External script support (modify route set)
-fifo                   Obsolete :: This module is replaced by the modules/ctl module
-gflags                 Proxy :: Global flags
-jabber                 IM :: Jabber gateway
-ldap                   LDAP directory server support
-mangler                        SDP mangling
-maxfwd                 Proxy :: Loop prevention (max-forwards header)
-msilo                  Offline message storage
-nathelper              NAT traversal :: RTP proxy (SIPPY software)
-options                        Proxy :: Support for SIP OPTION request
-oracle                 Database :: Oracle
-osp                    Open Settlement Protocol
-pa                     Presence :: server
-pdt                    Proxy :: Simple routing on number prefixes
-permissions            Security :: ACL support like TCP wrappers
-pike                   Security :: Rate limit control
-prefix_route           Proxy :: Routing based on a set of prefixes from the database
-presence_b2b           Presence :: Back2back UA
-print                  Example module for developers
-print_lib              Example module for developers
-ratelimit              Security :: Rate limit of SIP requests
-registrar              Registrar (for REGISTER requests)
-rls                    Resource list server (for presence)
-rr                     Proxy :: Record routing logic
-sanity                 Implement several sanity checks on incoming requests
-sl                     Proxy :: Stateless replies
-sms                    SMS gateway
-speeddial              Proxy :: Speed dialing for users
-textops                        Text operations (search, replace)
-timer                  triggering specific route block on timer
-tls                    TLS module * DEPRECATED * Use the modules/tls module instead
-uac                    User agent client
-unixsock               Obsolete :: This module is replaced by the modules/ctl module
-uri                    URI checks
-uri_db                 URI checks with database support
-usrloc                 Location server
-xcap                   Presence :: XCAP integration
-xlog                   Extended logging support