Revision: 15530
Author: baranowb
Date: Mon Nov 29 00:59:24 2010
Log: Updates Issue 1616
http://code.google.com/p/mobicents/source/detail?r=15530
Modified:
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Example.xml
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
=======================================
---
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
Wed Nov 10 04:31:38 2010
+++
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
Mon Nov 29 00:59:24 2010
@@ -8,52 +8,69 @@
<title>Design Overview</title>
<para>&THIS.PLATFORM; &THIS.APPLICATION;
- provides user with
- <acronym>NIO</acronym>
+ provides the user with
+ NIO
like transport abstraction.
User works with:
</para>
- <itemizedlist>
- <listitem>
- <para>Channel provider - factory class which creates
concrete
- implementaion of channel, which hides transport
details.</para>
- </listitem>
- <listitem>
- <para>Selector - object which can be queried about
state of channel
- I/O operations.</para>
- </listitem>
- <listitem>
- <para>Selection key - object encapsulating information
about I/O
- ready channel.</para>
- </listitem>
- <listitem>
- <para>Channel - object handling I/O operation</para>
- </listitem>
- <listitem>
- <para>
- <literal>M3UA</literal>
- Messages and Parameters - objects representing
specific metadata,
- like SS7 protocol message,
- <literal>M3UA</literal> management messages,
etc...
- </para>
- </listitem>
- </itemizedlist>
- <para>Diagram below depicts high level design:
+ <variablelist>
+ <varlistentry>
+ <term>Channel provider</term>
+ <listitem>
+ <para>
+ Factory class that creates a concrete implementaion of the
channel, that hides transport details.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Selector</term>
+ <listitem>
+ <para>
+ Object that can be queried about state of channel I/O operations.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Selection key</term>
+ <listitem>
+ <para>
+ Object encapsulating information about I/O ready channel.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Channel</term>
+ <listitem>
+ <para>
+ Object handling I/O operation.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>M3UA Messages and Parameters</term>
+ <listitem>
+ <para>
+ Objects representing specific metadata (such as SS7 protocol
messages and M3UA management messages)
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>The diagram below depicts the high level design:
</para>
- <mediaobject>
- <imageobject>
- <imagedata
- width="250px"
-
- align="center"
- fileref="images/design_1.png"
- format="PNG"/>
- </imageobject>
- <caption>
- <para>&THIS.PLATFORM; &THIS.APPLICATION; top
overview</para>
- </caption>
- </mediaobject>
- <para>Currently &THIS.PLATFORM; &THIS.APPLICATION; supports following
transports:</para>
+ <figure>
+ <title>&THIS.PLATFORM; &THIS.APPLICATION; top overview</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ width="250px"
+
+ align="center"
+ fileref="images/design_1.png"
+ format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>&THIS.PLATFORM; &THIS.APPLICATION; currently supports the following
transports:</para>
<itemizedlist>
<listitem>
<para>TCP</para>
=======================================
---
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Example.xml
Wed Nov 10 04:31:38 2010
+++
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Example.xml
Mon Nov 29 00:59:24 2010
@@ -8,7 +8,7 @@
<title>Example</title>
- <para>This chapter contains simple example of client and server
code.</para>
+ <para>This chapter contains a simple example of client and server
code.</para>
<section id="example.client">
<title>Client</title>
=======================================
---
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Wed Nov 10 04:31:38 2010
+++
/trunk/protocols/ss7/m3ua/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Mon Nov 29 00:59:24 2010
@@ -11,24 +11,17 @@
to &THIS.PLATFORM; &THIS.APPLICATION;
</title>
<para>
- <acronym>M3UA</acronym>
- stands for
- <literal>MTP3 User Adaptation Layer</literal>
- .
- <acronym>M3UA</acronym>
- addressses need of conecting
- <literal>SS7</literal>
- legacy services with IP entities like database servers.
- In techincal terms
- <acronym>M3UA</acronym>
- allows to exchange signaling between
+ M3UA stands for MTP3 User Adaptation Layer. M3UA addresses the need for
conecting SS7 legacy services with IP entities like database servers.
+ </para>
+ <para>
+ In technical terms, M3UA
+ allows for signaling between
<literal>Switched Circuit Network</literal>
- (SCN) border device(Signaling Gateway - SG) and Media Gateway
- Controler(MGC) or Database server.
+ (SCN) border devices (Signaling Gateway - SG) and Media Gateway
+ Controllers (MGC) or Database servers to be exchanged.
</para>
<para>
- <acronym>M3UA</acronym>
- transport mechanism covers following aspects:
+ The M3UA transport mechanism covers the following aspects:
</para>
<itemizedlist>
<listitem>
@@ -56,17 +49,17 @@
</listitem>
</itemizedlist>
- <para>Diagram below depicts <literal>M3UA</literal> relation to
protocols:</para>
- <mediaobject>
- <imageobject>
- <imagedata
- width="300px"
- align="center"
- fileref="images/m3ua_layering.png"
- format="PNG"/>
- </imageobject>
- <caption>
- <para>M3UA relations</para>
- </caption>
- </mediaobject>
+ <para>The diagram below depicts <literal>M3UA</literal> relationship to
protocols:</para>
+ <figure>
+ <title>M3UA relations</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ width="300px"
+ align="center"
+ fileref="images/m3ua_layering.png"
+ format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
</chapter>