Revision: 15533
Author: baranowb
Date: Mon Nov 29 01:04:56 2010
Log: Update Issue 1616
stream docs
http://code.google.com/p/mobicents/source/detail?r=15533
Modified:
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
=======================================
---
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
Tue Jul 13 06:56:53 2010
+++
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
Mon Nov 29 01:04:56 2010
@@ -8,102 +8,96 @@
<title>Design Overview</title>
<important>
- <para>Be
- aware, &THIS.PLATFORM; &THIS.APPLICATION;
- is subject to changes as it is under active development!
+ <para>
+ &THIS.PLATFORM; &THIS.APPLICATION; is subject to changes as it is
under active development.
</para>
</important>
- <para>&THIS.PLATFORM; &THIS.APPLICATION;
- builds layer of abstraction with
- <acronym>API</acronym>
- similar to
- <acronym>NIO</acronym>
- . Abstraction is built with three main components:
+ <para>
+ &THIS.PLATFORM; &THIS.APPLICATION; builds layers of abstraction with
API, similar to NIO. Abstraction is built with three main components:
</para>
- <itemizedlist>
- <listitem>
- <para>Selector - performs stream queries and presents
user with
- streams ready for I/O operations.</para>
- </listitem>
- <listitem>
- <para>SelectorKey - represents stream in selectors
space</para>
- </listitem>
- <listitem>
- <para>Stream - straight as it is, a stream of
data</para>
- </listitem>
- </itemizedlist>
- <mediaobject id="stream-design-overview1">
- <imageobject>
- <imagedata width="300px" align="center"
- fileref="images/stream-design-overview1.png"
format="PNG" />
- </imageobject>
- <caption>
- <para>
- IO overview
- </para>
- </caption>
- </mediaobject>
+ <variablelist>
+ <varlistentry>
+ <term>Selector</term>
+ <listitem>
+ <para>
+ Performs stream queries and presents the user with streams ready
for I/O operations.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>SelectorKey</term>
+ <listitem>
+ <para>
+ Represents stream in selectors space.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Stream</term>
+ <listitem>
+ <para>
+ A stream of data.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <figure>
+ <title>IO overview</title>
+ <mediaobject id="stream-design-overview1">
+ <imageobject>
+ <imagedata width="300px" align="center"
+ fileref="images/stream-design-overview1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </figure>
<section>
<title>Stream protocol - Datalink</title>
<para>
- Beside simplified stream
- <acronym>API</acronym>
- , there is also need for
- <acronym>SCTP</acronym>(SCTP
- is not available in JDK6) like streaming.
- &THIS.PLATFORM; &THIS.APPLICATION;
- provides such feature over defined stream
- <acronym>API</acronym>
- .
+ Beside a simplified stream API, there is also need for SCTP (SCTP is
not available in JDK6) like streaming. &THIS.PLATFORM; &THIS.APPLICATION;
provides this feature over a defined stream API.
</para>
<para>
- <literal>Datalink</literal>
- is a proprietary protocol designed to provide following:
+ Datalink is a proprietary protocol designed to provide the following
functions:
</para>
<itemizedlist>
<listitem>
- <para>peer to peer transport</para>
+ <para>Peer to Peer Transport</para>
</listitem>
<listitem>
- <para>reliable delivery - retransmissions</para>
+ <para>Reliable Delivery - Retransmissions</para>
</listitem>
<listitem>
- <para>stream status metadata - provide user
with stream status
+ <para>Stream Status Metadata - provides the
user with stream status
info(active,inactive, down...).
Metadata is information which
- ifnroms peers about readiness to receive data
for instance.</para>
+ informs peers about readiness to receive data
for instance.</para>
</listitem>
<listitem>
- <para>async I/O </para>
+ <para>async I/O</para>
</listitem>
</itemizedlist>
<para>
- Generaly
- <literal>Datalink</literal>
- can be imagined as follows:
+ Generally, Datalink can be imagined as follows:
</para>
- <mediaobject id="stream-link-design-overview1">
- <imageobject>
- <imagedata width="300px" align="center"
- fileref="images/stream-link-design-overview1.png"
format="PNG" />
- </imageobject>
- <caption>
- <para>
- Datalink overview
- </para>
- </caption>
- </mediaobject>
- <para>Datalink follows state machine which reassembles one depicted on
diagram below:</para>
- <mediaobject id="stream-link-design-overview2">
- <imageobject>
- <imagedata width="300px" align="center"
- fileref="images/stream-link-design-overview2.png"
format="PNG" />
- </imageobject>
- <caption>
- <para>
- Datalink FSM
- </para>
- </caption>
- </mediaobject>
+ <figure>
+ <title>Datalink overview</title>
+ <mediaobject id="stream-link-design-overview1">
+ <imageobject>
+ <imagedata width="300px" align="center"
+ fileref="images/stream-link-design-overview1.png" format="PNG"
/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Datalink follows the state machine, which reassembles one as depicted
below:
+ </para>
+ <figure>
+ <title>Datalink FSM</title>
+ <mediaobject id="stream-link-design-overview2">
+ <imageobject>
+ <imagedata width="300px" align="center"
+ fileref="images/stream-link-design-overview2.png" format="PNG"
/>
+ </imageobject>
+ </mediaobject>
+ </figure>
</section>
</chapter>
=======================================
---
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Tue Jul 13 06:56:53 2010
+++
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Mon Nov 29 01:04:56 2010
@@ -7,20 +7,13 @@
<chapter id="introduction">
- <title>Introduction
- to &THIS.PLATFORM; &THIS.APPLICATION;
+ <title>Introduction to &THIS.PLATFORM; &THIS.APPLICATION;
</title>
<para>
- In many places there is need for asynchronous I/O operations,
be it
- file, socket or any other. There are asynchronous I/O libraries.
- However
- implementations are thread safe and restricted to some specific
assumptions.
+ In many places there is need for asynchronous I/O operations, be it
file, socket or any other. There are asynchronous I/O libraries. However,
implementations are thread safe and restricted to some specific assumptions.
</para>
<para>
- &THIS.PLATFORM; &THIS.APPLICATION;
- fills this gap. It aims to provide simple
- <acronym>API</acronym>
- which enables user to abstract I/O operation in any way he
desires.
+ &THIS.PLATFORM; &THIS.APPLICATION; fills this gap. It aims to provide a
simple API which enables the user to abstract I/O operation in any way they
desire.
</para>
</chapter>
=======================================
---
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml
Tue Jul 13 06:56:53 2010
+++
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml
Mon Nov 29 01:04:56 2010
@@ -10,11 +10,15 @@
<section>
<title>Stream</title>
- <para>As mentioned stream module is centered on three main interfaces:
</para>
- <itemizedlist>
- <listitem>
- <para>org.mobicents.protocols.stream.api.Stream - this class declares
sets of methods to perform read and write operations, it looks as
follows:</para>
- <programlisting lang="JAVA" role="JAVA">
+ <para>As mentioned previously, the stream module is centered on three
main interfaces:</para>
+ <variablelist>
+ <varlistentry>
+ <term>org.mobicents.protocols.stream.api.Stream</term>
+ <listitem>
+ <para>
+ This class declares sets of methods to perform read and write
operations:
+ </para>
+ <programlisting lang="JAVA" role="JAVA">
public interface Stream {
/**
@@ -48,11 +52,16 @@
*/
public SelectorProvider provider();
}
- </programlisting>
- </listitem>
- <listitem>
- <para>org.mobicents.protocols.stream.api.StreamSelector - this
interface defines methods which are used to interrogate registered stream
for IO readiness.</para>
- <programlisting role="JAVA" lang="JAVA">
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>org.mobicents.protocols.stream.api.StreamSelector</term>
+ <listitem>
+ <para>
+ This interface defines methods that are used to interrogate
registered stream for IO readiness.
+ </para>
+ <programlisting role="JAVA" lang="JAVA">
public interface StreamSelector {
public static final int OP_READ = 0x1;
@@ -82,11 +91,16 @@
*/
public Collection<Stream> getRegisteredStreams();
}
- </programlisting>
- </listitem>
- <listitem>
- <para>org.mobicents.protocols.stream.api.SelectorKey - this interface
declares contarct for object representing stream in selector:</para>
- <programlisting lang="JAVA" role="JAVA">
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>org.mobicents.protocols.stream.api.SelectorKey</term>
+ <listitem>
+ <para>
+ This interface declares the contract for the object representing
the stream in selector:
+ </para>
+ <programlisting lang="JAVA" role="JAVA">
public interface SelectorKey {
/**
* Attach application specific object to this key. When underlying stream
is
@@ -143,10 +157,12 @@
*/
public void cancel(); // Oleg verify this.
}
- </programlisting>
- </listitem>
- </itemizedlist>
- <para>Example use of this <acronym>API</acronym> looks as
follows:
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ Below is an example use of this API:
</para>
<programlisting lang="JAVA" role="JAVA">
Stream s = ....
@@ -170,7 +186,8 @@
</section>
<section>
<title>Datalink</title>
- <para>Datalink is basicaly small extension to async stream. Below
example classes depict difference and use case:</para>
+ <para>
+ Datalink is basically a small extension of the async stream. The
example below shows the difference and use case:</para>
<programlisting lang="JAVA" role="JAVA">
import org.mobicents.protocols.link.DataLink;
import org.mobicents.protocols.link.LinkState;
=======================================
---
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Jul 13 06:56:53 2010
+++
/trunk/protocols/stream/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Mon Nov 29 01:04:56 2010
@@ -8,7 +8,7 @@
<title>Setup</title>
- <section id="preinstall_requirements_and_prerequisites">
+ <!--<section id="preinstall_requirements_and_prerequisites">
<title>Pre-Install Requirements and Prerequisites</title>
<para>Ensure that the following requirements have been met before
continuing with the install.</para>
<section id="hardware_requirements">
@@ -20,7 +20,7 @@
<title>Software Prerequisites</title>
<para>The library does not have dependencies.</para>
</section>
- </section>
+ </section>--><!--Note: This section is not needed as no requirements are
present.-->
<section id="source_code">
<title>&THIS.PLATFORM; &THIS.APPLICATION; Source Code</title>