Revision: 28bc88e94ebf
Author:   Jean Deruelle <[email protected]>
Date:     Wed Aug  1 03:37:05 2012
Log:      Update Issue 3

Cosmetic Edits

http://code.google.com/p/jain-sip/source/detail?r=28bc88e94ebf&repo=docs

Modified:
 /sources/src/main/resources/en-US/Author_Group.xml
 /sources/src/main/resources/en-US/concept-chapter-Introduction.xml
 /sources/src/main/resources/en-US/concept-chapter-NIO-Architecture.xml

=======================================
--- /sources/src/main/resources/en-US/Author_Group.xml Thu Jun 28 12:59:21 2012 +++ /sources/src/main/resources/en-US/Author_Group.xml Wed Aug 1 03:37:05 2012
@@ -7,6 +7,11 @@
        <author>
                <firstname>Jean</firstname>
                <surname>Deruelle</surname>
-               <email>[email protected]</email>
+               <email>[email protected]</email>
        </author>
+       <author>
+               <firstname>Charles</firstname>
+               <surname>Roufay</surname>
+               <email>[email protected]</email>
+       </author>
 </authorgroup>
=======================================
--- /sources/src/main/resources/en-US/concept-chapter-Introduction.xml Thu Jun 28 12:59:21 2012 +++ /sources/src/main/resources/en-US/concept-chapter-Introduction.xml Wed Aug 1 03:37:05 2012
@@ -5,6 +5,12 @@
 ]>
 <chapter id="Introduction_to_the_jSIP">
        <title>Introduction to &SHORT_PLATFORM_NAME;</title>
- <para>&SHORT_PLATFORM_NAME; is an open source implementation of the JAIN SIP (JSR 32) Specification. + <para><ulink url="http://code.google.com/p/jain-sip/";>&SHORT_PLATFORM_NAME;</ulink> is an open source implementation of the JAIN SIP (JSR 32) Specification.
+       </para>
+       <para>
+ This project publishes the Reference Implementation, Technology Compatibility Kit, examples and tools for JAIN-SIP-1.2 (JSR-32 maintenance release) and an SDP library that conforms to the public release of JSR 141 (JAIN-SDP) interfaces. JAIN-SIP is a low level Java API speicification for SIP Signaling. The intended users of this project are SIP developers. It publishes a full implementation of the RFC 3261 Specification and as well as support for several SIP RFCs and IMS Extensions.
+       </para>
+       <para>
+ In addition, the project provides extensions for some features that are not supported by the main jain sip stack, like DNS Support (RFC3263) or provide high availability and fault tolerance through replication of various states of the stack. It supports Call Established Failover or Early Dialog Failover.
        </para>
 </chapter>
=======================================
--- /sources/src/main/resources/en-US/concept-chapter-NIO-Architecture.xml Wed Jul 25 09:00:49 2012 +++ /sources/src/main/resources/en-US/concept-chapter-NIO-Architecture.xml Wed Aug 1 03:37:05 2012
@@ -84,55 +84,51 @@
It is important to understand that sockets are separate from calls. One socket can carry many calls thus the lifespan of a socket is independent from the call itself. With NIO there is no need to have non-caching sockets. All sockets are cached and do not consume threads to maintain the connection. However, NIOHandler.SocketTimeoutAuditor timer task thread periodically checks for sockets that have been idle for too long and closes them to avoid accumulating leaks in long-running systems.
 </para>

-<para>Configuration </para>
+<section>
+<title>Stack Configuration</title>

 <para>

-Most BIO settings were adapted for NIO including the TLS settings. Only gov.nist.javax.sip.NIO_MAX_SOCKET_IDLE_TIME is new with default value 7200000 (2 hours in milliseconds). +Most <ulink url="https://mobicents.ci.cloudbees.com/job/JAIN-SIP/lastSuccessfulBuild/artifact/jain-sip/javadoc/index.html?gov/nist/javax/sip/SipStackImpl.html";>JAIN SIP BIO settings</ulink> were adapted for NIO including the TLS settings. Only <literal>gov.nist.javax.sip.NIO_MAX_SOCKET_IDLE_TIME</literal> is new with default value 7200000 (2 hours in milliseconds).

 </para>

 <para>
-It is strongly recommended that you set the size of the parsing threadpool in the gov.nist.javax.sip.TCP_POST_PARSING_THREAD_POOL_SIZE to at least 4. Even though the stack will work without this threadpool, disabling it means everything will occur in the selector thread, which can cause the server to eventually grind to a halt. +It is strongly recommended that you set the size of the parsing threadpool in the <literal>gov.nist.javax.sip.TCP_POST_PARSING_THREAD_POOL_SIZE</literal> to at least 4. Even though the stack will work without this threadpool, disabling it means everything will occur in the selector thread, which can cause the server to eventually grind to a halt.
 </para>
-
+</section>
+
+<section>
+<title>OS Configuration</title>
+
 <para>
-OS configuration for large number of sockets
+For large number of sockets, if you want to find out more about setting the maximum limits on Linux server, you go to this link: <ulink url="http://serverfault.com/questions/10852/what-limits-the-maximum-number-of-connections-on-a-linux-server";>Linux Maximum Connection Settings</ulink>
 </para>

 <para>
-If you want to find out more about setting the maximum limits on Linux server, you go to this link: <ulink url="http://serverfault.com/questions/10852/what-limits-the-maximum-number-of-connections-on-a-linux-server";>Linux Maximum Connection Settings</ulink> +In addition to that (<literal>ulimit -n</literal>) may restrict the sockets per terminal, so make sure you run the server from a terminal that has the ulimit set to a high value. This is also applies to those working on Mac OS.
 </para>
-
-<para>
-In addition to that (ulimit -n) may restrict the sockets per terminal, so make sure you run the server from a terminal that has the ulimit set to a high value. This is also applies to those working on Mac OS.
-</para>
-
+</section>
 </section>

 <section>
 <title> Memory Model</title>
-
-
-
+<section>
+<title> TCP</title>

 <para>
-TCP
+For every socket, we maintain the SocketChannel, a NioPipelineParser and a long integer timstamp. The rest of the state comes from the generic <literal>ConnectionOrientedMessageChannel</literal> which is shared with BIO. The memory consumed per socket is insignificant - just a couple of kilobytes plus temporary buffering of the messages themselves.
 </para>
-
+</section>
+
+<section>
+<title> TLS</title>
 <para>
-For every socket, we maintain the SocketChannel, a NioPipelineParser and a long integer timstamp. The rest of the state comes from the generic ConnectionOrientedMessageChannel which is shared with BIO. The memory consumed per socket is insignificant - just a couple of kilobytes plus temporary buffering of the messages themselves.
-</para>
-
-<para>
-TLS
-</para>
-
-<para>
-
-On top of the TCP message channel, each socket has two buffers to be used in wrap() and unwrap() operations. These buffers are sized by the recommended values from the SSL session and usually they are 30-60 KB. These buffers can be resized by doubling the size while the call is in progress. Netty has a mechanism to optimize memory using buffer pools, we can leave this option as a TODO for later. On top of that we maintain SSL state and references to underlying SSLEngine objects.
+
+On top of the TCP message channel, each socket has two buffers to be used in <literal>wrap()</literal> and <literal>unwrap()</literal> operations. These buffers are sized by the recommended values from the SSL session and usually they are 30-60 KB. These buffers can be resized by doubling the size while the call is in progress. Netty has a mechanism to optimize memory using buffer pools, we can leave this option as a TODO for later. On top of that we maintain SSL state and references to underlying SSLEngine objects.

 </para>
 </section>
+</section>

 </chapter>

Reply via email to