aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2009-02-27 21:48:00 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2009-02-27 21:48:00 +0000
commitef2bde00548e25f8703dc8f41cd09c5e52418f42 (patch)
tree96f2874061ee75f690e0593ec82b9b0f3bfb8c2c
parent4b448c72d76f6aaa72ba5de2f8bdce08d2340fd0 (diff)
Merged revisions 179164 via svnmerge from
https://origsvn.digium.com/svn/asterisk/trunk ........ r179164 | russell | 2009-02-27 15:47:18 -0600 (Fri, 27 Feb 2009) | 2 lines Mark res_ais as experimental, as the binary event format is subject to change. ........ git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.6.1@179166 f38db490-d61c-443f-a65b-d21fe96a405b
-rw-r--r--configs/ais.conf.sample9
-rw-r--r--doc/distributed_devstate.txt10
-rw-r--r--res/res_ais.c4
3 files changed, 23 insertions, 0 deletions
diff --git a/configs/ais.conf.sample b/configs/ais.conf.sample
index 42991a6ca..f0bccc639 100644
--- a/configs/ais.conf.sample
+++ b/configs/ais.conf.sample
@@ -11,6 +11,15 @@
;
;
+; *** NOTE ***
+; This document includes some information about using the res_ais module for
+; distributed events. However, it is important to note that res_ais is still
+; considered experimental, as the module exposes the binary format of events
+; over the network between servers. This format is still subject to change
+; between 1.6.X releases.
+; ************
+
+;
; [general]
; The general section is reserved but not currently used.
;
diff --git a/doc/distributed_devstate.txt b/doc/distributed_devstate.txt
index 0339093cb..954fdbca0 100644
--- a/doc/distributed_devstate.txt
+++ b/doc/distributed_devstate.txt
@@ -8,6 +8,16 @@
===============================================================================
-------------------------------------------------------------------------------
+--- IMPORTANT NOTE
+-------------------------------------------------------------------------------
+
+This document includes some information about using the res_ais module for
+distributed events. However, it is important to note that res_ais is still
+considered experimental, as the module exposes the binary format of events
+over the network between servers. This format is still subject to change
+between 1.6.X releases.
+
+-------------------------------------------------------------------------------
--- INTRODUCTION
-------------------------------------------------------------------------------
diff --git a/res/res_ais.c b/res/res_ais.c
index 865f42458..adb3290e1 100644
--- a/res/res_ais.c
+++ b/res/res_ais.c
@@ -26,6 +26,10 @@
*
* This file contains the common code between the uses of the different AIS
* services.
+ *
+ * \note This module is still considered experimental, as it exposes the
+ * internal binary format of events between Asterisk servers over a network.
+ * However, this format is still subject to change between 1.6.X releases.
*/
/*** MODULEINFO