aboutsummaryrefslogtreecommitdiffstats
path: root/doc/realtime.txt
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2007-03-15 22:25:12 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2007-03-15 22:25:12 +0000
commit3bc7e211a435c49aa70ad227799bd7b0c40356a1 (patch)
treed8e5262f1e1a9faad716b36f59a6b3fe65c288bd /doc/realtime.txt
parenta63acaa328b9937677f3f5c4d861889a6e369034 (diff)
Merge changes from svn/asterisk/team/russell/LaTeX_docs.
* Convert most of the doc directory into a single LaTeX formatted document so that we can generate a PDF, HTML, or other formats from this information. * Add a CLI command to dump the application documentation into LaTeX format which will only be include if the configure script is run with --enable-dev-mode. * The PDF turned out to be close to 1 MB, so it is not included. However, you can simply run "make asterisk.pdf" to generate it yourself. We may include it in release tarballs or have automatically generated ones on the web site, but that has yet to be decided. git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@58931 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc/realtime.txt')
-rw-r--r--doc/realtime.txt126
1 files changed, 0 insertions, 126 deletions
diff --git a/doc/realtime.txt b/doc/realtime.txt
deleted file mode 100644
index cc415ab73..000000000
--- a/doc/realtime.txt
+++ /dev/null
@@ -1,126 +0,0 @@
-The Asterisk Realtime Architecture
-----------------------------------
-
-The Asterisk Realtime Architecture is a new set of drivers and
-functions implemented in Asterisk.
-
-The benefits of this architecture are many, both from a code management
-standpoint and from an installation perspective.
-
-Additional information on the configuration of Realtime with Asterisk
-can be found in doc/extconfig.txt
-
-The ARA is designed to be independent of storage. Currently, most
-drivers are based on SQL, but the architecture should be able to handle
-other storage methods in the future, like LDAP.
-
-The main benefit comes in the database support. In Asterisk v1.0 some
-functions supported MySQL database, some PostgreSQL and other ODBC.
-With the ARA, we have a unified database interface internally in Asterisk,
-so if one function supports database integration, all databases that has a
-realtime driver will be supported in that function.
-
-Currently there are three realtime database drivers:
-
-* ODBC: Support for UnixODBC, integrated into Asterisk
- The UnixODBC subsystem supports many different databases,
- please check www.unixodbc.org for more information.
-* MySQL: Found in the asterisk-addons subversion repository on svn.digium.com
-* PostgreSQL: Native support for Postgres, integrated into Asterisk
-
-* Two modes: Static and Realtime
---------------------------------
-The ARA realtime mode is used to dynamically load and update objects.
-This mode is used in the SIP and IAX2 channels, as well as in the voicemail
-system. For SIP and IAX2 this is similar to the v1.0 MYSQL_FRIENDS
-functionality. With the ARA, we now support many more databases for
-dynamic configuration of phones.
-
-The ARA static mode is used to load configuration files. For the Asterisk
-modules that read configurations, there's no difference between a static
-file in the file system, like extensions.conf, and a configuration loaded
-from a database.
-
-* Realtime SIP friends
-----------------------
-The SIP realtime objects are users and peers that are loaded in memory
-when needed, then deleted. This means that Asterisk currently can't handle
-voicemail notification and NAT keepalives for these peers. Other than that,
-most of the functionality works the same way for realtime friends as for
-the ones in static configuration.
-
-With caching, the device stays in memory for a specified time. More
-information about this is to be found in the sip.conf sample file.
-
-* Realtime H.323 friends
-------------------------
-Like SIP realtime friends, H.323 friends also can be configured using
-dynamic realtime objects.
-
-* New function in the dial plan: The Realtime Switch
-----------------------------------------------------
-The realtime switch is more than a port of functionality in v1.0 to the
-new architecture, this is a new feature of Asterisk based on the
-ARA. The realtime switch lets your Asterisk server do database lookups
-of extensions in realtime from your dial plan. You can have many Asterisk
-servers sharing a dynamically updated dial plan in real time with this
-solution.
-
-Note that this switch does _NOT_ support Caller ID matching, only
-extension name/pattern matching.
-
-* So what can you do?
----------------------
-The realtime Architecture lets you store all of your configuration in
-databases and reload it whenever you want. You can force a reload over
-the AMI, Asterisk Manager Interface or by calling Asterisk from a
-shell script with
- asterisk -rx "reload"
-
-You may also dynamically add SIP and IAX devices and extensions
-and making them available without a reload, by using the realtime
-objects and the realtime switch.
-
-
-* Configuration in extconfig.conf
----------------------------------
-You configure the ARA in extconfig.conf (yes, it's a strange name, but
-is was defined in the early days of the realtime architecture and kind
-of stuck). Please see doc/extconfig.txt for database schemas.
-
-The part of Asterisk that connects to the ARA use a well defined family
-name to find the proper database driver. The syntax is easy:
- <family> => <realtime driver>,<db name>[,<table>]
-
-The options following the realtime driver identified depends on the
-driver.
-
-Defined well-known family names are:
-
-* sippeers, sipusers SIP peers and users
-* iaxpeers, iaxusers IAX2 peers and users
-* voicemail Voicemail accounts
-* queues Queues
-* queue_members Queue members
-* extensions Realtime extensions (switch)
-
-There is documentation of the SQL database in the file
-doc/extconfig.txt in your Asterisk source code tree.
-
-For voicemail storage with the support of ODBC, there is a
-doc/odbcstorage.txt documentation file.
-
-
-* Limitations
--------------
-Currently, realtime extensions do not support realtime hints. There is
-a workaround available by using func_odbc. See the sample func_odbc.conf
-for more information.
-
-
-* FreeTDS supported with connection pooling
--------------------------------------------
-In order to use a FreeTDS-based database with realtime, you need to turn
-connection pooling on in res_odbc.conf. This is due to a limitation within
-the FreeTDS protocol itself. Please note that this includes databases such
-as MS SQL Server and Sybase. This support is new in the current release.