* Move LaTeX docs into a tex/ subdirectory of the doc/ dir
[asterisk/asterisk.git] / doc / tex / realtime.tex
1 \subsubsection{Introduction}
2
3 The Asterisk Realtime Architecture is a new set of drivers and 
4 functions implemented in Asterisk.
5
6 The benefits of this architecture are many, both from a code management
7 standpoint and from an installation perspective. 
8
9 Additional information on the configuration of Realtime with Asterisk 
10 can be found in doc/extconfig.txt
11
12 The ARA is designed to be independent of storage. Currently, most
13 drivers are based on SQL, but the architecture should be able to handle
14 other storage methods in the future, like LDAP.
15
16 The main benefit comes in the database support. In Asterisk v1.0 some 
17 functions supported MySQL database, some PostgreSQL and other ODBC.
18 With the ARA, we have a unified database interface internally in Asterisk,
19 so if one function supports database integration, all databases that has a 
20 realtime driver will be supported in that function.
21
22 Currently there are three realtime database drivers:
23
24 \begin{itemize}
25   \item ODBC: Support for UnixODBC, integrated into Asterisk
26         The UnixODBC subsystem supports many different databases,
27         please check www.unixodbc.org for more information.
28   \item MySQL: Found in the asterisk-addons subversion repository on svn.digium.com
29   \item PostgreSQL: Native support for Postgres, integrated into Asterisk
30 \end{itemize}
31
32 \subsubsection{Two modes: Static and Realtime}
33
34 The ARA realtime mode is used to dynamically load and update objects.
35 This mode is used in the SIP and IAX2 channels, as well as in the voicemail
36 system. For SIP and IAX2 this is similar to the v1.0 MYSQL\_FRIENDS 
37 functionality. With the ARA, we now support many more databases for
38 dynamic configuration of phones.
39
40 The ARA static mode is used to load configuration files. For the Asterisk
41 modules that read configurations, there's no difference between a static
42 file in the file system, like extensions.conf, and a configuration loaded
43 from a database.
44
45 \subsubsection{Realtime SIP friends}
46
47 The SIP realtime objects are users and peers that are loaded in memory 
48 when needed, then deleted. This means that Asterisk currently can't handle
49 voicemail notification and NAT keepalives for these peers. Other than that,
50 most of the functionality works the same way for realtime friends as for
51 the ones in static configuration.
52
53 With caching, the device stays in memory for a specified time. More 
54 information about this is to be found in the sip.conf sample file.
55
56 \subsubsection{Realtime H.323 friends}
57
58 Like SIP realtime friends, H.323 friends also can be configured using
59 dynamic realtime objects.
60
61 \subsubsection{New function in the dial plan: The Realtime Switch}
62
63 The realtime switch is more than a port of functionality in v1.0 to the
64 new architecture, this is a new feature of Asterisk based on the 
65 ARA. The realtime switch lets your Asterisk server do database lookups
66 of extensions in realtime from your dial plan. You can have many Asterisk
67 servers sharing a dynamically updated dial plan in real time with this
68 solution.
69
70 Note that this switch does NOT support Caller ID matching, only
71 extension name or pattern matching.
72
73 \subsubsection{Capabilities}
74
75 The realtime Architecture lets you store all of your configuration in
76 databases and reload it whenever you want. You can force a reload over
77 the AMI, Asterisk Manager Interface or by calling Asterisk from a 
78 shell script with 
79
80         asterisk -rx "reload"
81
82 You may also dynamically add SIP and IAX devices and extensions 
83 and making them available without a reload, by using the realtime
84 objects and the realtime switch.
85
86 \subsubsection{Configuration in extconfig.conf}
87
88 You configure the ARA in extconfig.conf (yes, it's a strange name, but
89 is was defined in the early days of the realtime architecture and kind
90 of stuck). Please see doc/extconfig.txt for database schemas.
91
92 The part of Asterisk that connects to the ARA use a well defined family
93 name to find the proper database driver. The syntax is easy:
94
95 \begin{verbatim}
96     <family> => <realtime driver>,<db name>[,<table>]
97 \end{verbatim}
98
99 The options following the realtime driver identified depends on the
100 driver.
101
102 Defined well-known family names are:
103
104 \begin{itemize}
105   \item sippeers, sipusers - SIP peers and users
106   \item iaxpeers, iaxusers - IAX2 peers and users
107   \item voicemail - Voicemail accounts 
108   \item queues - Queues
109   \item queue\_members - Queue members
110   \item extensions - Realtime extensions (switch)
111 \end{itemize}
112
113 There is documentation of the SQL database in the file
114 doc/extconfig.txt in your Asterisk source code tree.
115
116 For voicemail storage with the support of ODBC, there is a 
117 doc/odbcstorage.txt documentation file.
118
119 \subsubsection{Limitations}
120
121 Currently, realtime extensions do not support realtime hints.  There is
122 a workaround available by using func\_odbc.  See the sample func\_odbc.conf
123 for more information.
124
125 \subsubsection{FreeTDS supported with connection pooling}
126
127 In order to use a FreeTDS-based database with realtime, you need to turn
128 connection pooling on in res\_odbc.conf.  This is due to a limitation within
129 the FreeTDS protocol itself.  Please note that this includes databases such
130 as MS SQL Server and Sybase.  This support is new in the current release.