[svn-commits] russell: branch russell/messaging r298284 - /team/russell/messaging/doc/

[SVN commits to the Digium repositories]

Author: russell
Date: Mon Dec 13 12:42:16 2010
New Revision: 298284

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=298284
Log:
some doc updates.

Modified:
    team/russell/messaging/doc/asterisk-messaging.txt

Modified: team/russell/messaging/doc/asterisk-messaging.txt
URL: http://svnview.digium.com/svn/asterisk/team/russell/messaging/doc/asterisk-messaging.txt?view=diff&rev=298284&r1=298283&r2=298284
==============================================================================
--- team/russell/messaging/doc/asterisk-messaging.txt (original)
+++ team/russell/messaging/doc/asterisk-messaging.txt Mon Dec 13 12:42:16 2010
@@ -12,6 +12,7 @@
 --------------------------------------------------------------------------------
 
     1) Introduction
+        1.1) Scope
     2) The Asterisk Dialplan
         2.1) MESSAGE() Function
         2.2) MessageSend() Application
@@ -52,6 +53,21 @@
 will be achieved in a way that is both architecturally compatible with Asterisk
 as well as practical to implement.
 
+
+--- 1.1) Scope
+
+    There are three types of messaging worth considering with Asterisk.
+
+        1) One-off messages outside of a call
+           (SMS, XMPP, SIP MESSAGE outside of a call, etc.)
+        2) One-off messages inside of a call
+           (IAX2 text frames, SIP MESSAGE within a call, etc.)
+        3) Session based messaging (SIP with MSRP, etc.)
+        4) Text streams associated with a call (SIP with T.140 RTP)
+
+    #2 and #4 already exist in Asterisk.  This proposal is limited in scope to
+adding support for #1.  #3 is explicitly outside of the scope of this proposal.
+
 --------------------------------------------------------------------------------
 --------------------------------------------------------------------------------
 
@@ -81,7 +97,8 @@
         body - Read/Write.  The message body.  When processing an incoming
                message, this includes the body of the message that Asterisk
                received.  When MessageSend() is executed, the contents of this
-               field are used as the body of the outgoing message.
+               field are used as the body of the outgoing message.  The body
+               will always be UTF-8.
 
 
 --- 2.2) MessageSend() Application
@@ -222,13 +239,6 @@
 --- 6) TODO / Ideas / Future Improvements
 --------------------------------------------------------------------------------
 
-Documentation:
-    -> Clearly document architectural approach to different types of text
-       messaging:
-         - one-off messages like SMS, most IMs
-         - session based IMs, like SIP with MSRP
-         - T.140 text streams, other text within a call
-
 Core:
 
     -> Add local: URI support which could be used with MessageSend() to allow an
@@ -239,8 +249,6 @@
            MessageSend(xmpp:user1&xmpp:user2&local:1234 at default)
 
     -> Use stringfields (for fields where it is appropriate)
-
-    -> Consider character set issues.
 
 SIP (chan_sip):