Author: buildbot
Date: Tue Sep 20 22:09:16 2016
New Revision: 997871
Log:
Staging update by buildbot for mina
Modified:
websites/staging/mina/trunk/content/ (props changed)
websites/staging/mina/trunk/content/mina-project/userguide/ch4-session/ch4.1-session-configuration.html
websites/staging/mina/trunk/content/mina-project/userguide/ch4-session/ch4.2-session-statistics.html
Propchange: websites/staging/mina/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Sep 20 22:09:16 2016
@@ -1 +1 @@
-1761649
+1761650
Modified:
websites/staging/mina/trunk/content/mina-project/userguide/ch4-session/ch4.1-session-configuration.html
==============================================================================
---
websites/staging/mina/trunk/content/mina-project/userguide/ch4-session/ch4.1-session-configuration.html
(original)
+++
websites/staging/mina/trunk/content/mina-project/userguide/ch4-session/ch4.1-session-configuration.html
Tue Sep 20 22:09:16 2016
@@ -192,42 +192,226 @@ h2:hover > .headerlink, h3:hover > .head
</ul>
<h2 id="general-parameters">General parameters<a class="headerlink"
href="#general-parameters" title="Permanent link">¶</a></h2>
<p>Here is the list of all the global parameters (they can be set fo any of
the Session flavors) :</p>
-<p>|| Parameter || type || Description || Default value ||
-| idleTimeForBoth | int | The number of seconds to wait before notify a
session that is idle on reads and writes | Infinite |
-| idleTimeForRead | int | The number of seconds to wait before notify a
session that is idle on reads | Infinite |
-| idleTimeForWrite | int | The number of seconds to wait before notify a
session that is idle on writes | Infinite |
-| maxReadBufferSize | int | The maximum size of the buffer used to read
incomming data | 65536 bytes |
-| minReadBufferSize | int | The minimal size of the buffer used to read
incomming data | 64 bytes |
-| readBufferSize | int | The default size of the buffer used to read incomming
data | 2048 bytes |
-| throughputCalculationInterval | int | The interval (seconds) between each
throughput calculation. | 3s |
-| useReadOperation | boolean | A flag set to TRUE when we allow an application
to do a __session.read()_ | FALSE |
-| writeTimeout | int | Delay to wait for completion before bailing out a write
operation | 60s |</p>
+<table class="table">
+<thead>
+<tr>
+<th>Parameter</th>
+<th>type</th>
+<th>Description</th>
+<th>Default value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>idleTimeForBoth</td>
+<td>int</td>
+<td>The number of seconds to wait before notify a session that is idle on
reads and writes</td>
+<td>Infinite</td>
+</tr>
+<tr>
+<td>idleTimeForRead</td>
+<td>int</td>
+<td>The number of seconds to wait before notify a session that is idle on
reads</td>
+<td>Infinite</td>
+</tr>
+<tr>
+<td>idleTimeForWrite</td>
+<td>int</td>
+<td>The number of seconds to wait before notify a session that is idle on
writes</td>
+<td>Infinite</td>
+</tr>
+<tr>
+<td>maxReadBufferSize</td>
+<td>int</td>
+<td>The maximum size of the buffer used to read incomming data</td>
+<td>65536 bytes</td>
+</tr>
+<tr>
+<td>minReadBufferSize</td>
+<td>int</td>
+<td>The minimal size of the buffer used to read incomming data</td>
+<td>64 bytes</td>
+</tr>
+<tr>
+<td>readBufferSize</td>
+<td>int</td>
+<td>The default size of the buffer used to read incomming data</td>
+<td>2048 bytes</td>
+</tr>
+<tr>
+<td>throughputCalculationInterval</td>
+<td>int</td>
+<td>The interval (seconds) between each throughput calculation.</td>
+<td>3s</td>
+</tr>
+<tr>
+<td>useReadOperation</td>
+<td>boolean</td>
+<td>A flag set to TRUE when we allow an application to do a
__session.read()_</td>
+<td>FALSE</td>
+</tr>
+<tr>
+<td>writeTimeout</td>
+<td>int</td>
+<td>Delay to wait for completion before bailing out a write operation</td>
+<td>60s</td>
+</tr>
+</tbody>
+</table>
<p>All those parameters can be accessed through the use of getters and setters
(the <em>useReadOperation</em> parameter getter is using the
<em>isUseReadOperation()</em> method).</p>
<h2 id="socket-specific-parameters">Socket specific parameters<a
class="headerlink" href="#socket-specific-parameters" title="Permanent
link">¶</a></h2>
-<p>|| Parameter || type || Description || Default value ||
-| defaultReuseAddress | boolean | The value for the SO_REUSEADDR flag | true |
-| keepAlive | boolean | The value for the SO_KEEPALIVE flag | false |
-| oobInline | boolean | The value for the SO_OOBINLINE flag | false |
-| receiveBufferSize | int | The value for the SO_RCVBUF parameter | -1 |
-| reuseAddress | boolean | The value for the SO_REUSEADDR flag | false |
-| sendBufferSize | int | The value for the SO_SNDBUF parameter | -1 |
-| soLinger | int | The value for the SO_LINGER parameter | -1 |
-| tcpNoDelay | boolean | The value for the TCP_NODELAY flag | false |
-| trafficClass | int | The value for the IP_TOS parameter. One of
IPTOS_LOWCOST(0x02), IPTOS_RELIABILITY(0x04), IPTOS_THROUGHPUT (0x08) or
IPTOS_LOWDELAY (0x10) | 0 |</p>
+<table class="table">
+<thead>
+<tr>
+<th>Parameter</th>
+<th>type</th>
+<th>Description</th>
+<th>Default value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>defaultReuseAddress</td>
+<td>boolean</td>
+<td>The value for the SO_REUSEADDR flag</td>
+<td>true</td>
+</tr>
+<tr>
+<td>keepAlive</td>
+<td>boolean</td>
+<td>The value for the SO_KEEPALIVE flag</td>
+<td>false</td>
+</tr>
+<tr>
+<td>oobInline</td>
+<td>boolean</td>
+<td>The value for the SO_OOBINLINE flag</td>
+<td>false</td>
+</tr>
+<tr>
+<td>receiveBufferSize</td>
+<td>int</td>
+<td>The value for the SO_RCVBUF parameter</td>
+<td>-1</td>
+</tr>
+<tr>
+<td>reuseAddress</td>
+<td>boolean</td>
+<td>The value for the SO_REUSEADDR flag</td>
+<td>false</td>
+</tr>
+<tr>
+<td>sendBufferSize</td>
+<td>int</td>
+<td>The value for the SO_SNDBUF parameter</td>
+<td>-1</td>
+</tr>
+<tr>
+<td>soLinger</td>
+<td>int</td>
+<td>The value for the SO_LINGER parameter</td>
+<td>-1</td>
+</tr>
+<tr>
+<td>tcpNoDelay</td>
+<td>boolean</td>
+<td>The value for the TCP_NODELAY flag</td>
+<td>false</td>
+</tr>
+<tr>
+<td>trafficClass</td>
+<td>int</td>
+<td>The value for the IP_TOS parameter. One of IPTOS_LOWCOST(0x02),
IPTOS_RELIABILITY(0x04), IPTOS_THROUGHPUT (0x08) or IPTOS_LOWDELAY (0x10)</td>
+<td>0</td>
+</tr>
+</tbody>
+</table>
<h2 id="datagram-specific-parameters">Datagram specific parameters<a
class="headerlink" href="#datagram-specific-parameters" title="Permanent
link">¶</a></h2>
-<p>|| Parameter || type || Description || Default value ||
-| broadcast | boolean | The value for the SO_BROADCAST flag | false |
-| closeOnPortUnreachable | boolean | Tells if we should close the session if
the port is unreachable | true |
-| receiveBufferSize | int | The value for the SO_RCVBUF parameter | -1 |
-| reuseAddress | boolean | The value for the SO_REUSEADDR flag | false |
-| sendBufferSize | int | The value for the SO_SNDBUF parameter | -1 |
-| trafficClass | int | The value for the IP_TOS parameter. One of
IPTOS_LOWCOST(0x02), IPTOS_RELIABILITY(0x04), IPTOS_THROUGHPUT (0x08) or
IPTOS_LOWDELAY (0x10) | 0 |</p>
+<table class="table">
+<thead>
+<tr>
+<th>Parameter</th>
+<th>type</th>
+<th>Description</th>
+<th>Default value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>broadcast</td>
+<td>boolean</td>
+<td>The value for the SO_BROADCAST flag</td>
+<td>false</td>
+</tr>
+<tr>
+<td>closeOnPortUnreachable</td>
+<td>boolean</td>
+<td>Tells if we should close the session if the port is unreachable</td>
+<td>true</td>
+</tr>
+<tr>
+<td>receiveBufferSize</td>
+<td>int</td>
+<td>The value for the SO_RCVBUF parameter</td>
+<td>-1</td>
+</tr>
+<tr>
+<td>reuseAddress</td>
+<td>boolean</td>
+<td>The value for the SO_REUSEADDR flag</td>
+<td>false</td>
+</tr>
+<tr>
+<td>sendBufferSize</td>
+<td>int</td>
+<td>The value for the SO_SNDBUF parameter</td>
+<td>-1</td>
+</tr>
+<tr>
+<td>trafficClass</td>
+<td>int</td>
+<td>The value for the IP_TOS parameter. One of IPTOS_LOWCOST(0x02),
IPTOS_RELIABILITY(0x04), IPTOS_THROUGHPUT (0x08) or IPTOS_LOWDELAY (0x10)</td>
+<td>0</td>
+</tr>
+</tbody>
+</table>
<h2 id="serial-specific-parameters">Serial specific parameters<a
class="headerlink" href="#serial-specific-parameters" title="Permanent
link">¶</a></h2>
-<p>|| Parameter || type || Description || Default value ||
-| inputBufferSize | int | The input buffer size to use | 8 |
-| lowLatency | boolean | Set the Low Latency mode | false |
-| outputBufferSize | int | The ouput buffer size to use | 8 |
-| receiveThreshold | int | Set the receive threshold in byte (set it to -1 for
disable) | -1 |</p>
+<table class="table">
+<thead>
+<tr>
+<th>Parameter</th>
+<th>type</th>
+<th>Description</th>
+<th>Default value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>inputBufferSize</td>
+<td>int</td>
+<td>The input buffer size to use</td>
+<td>8</td>
+</tr>
+<tr>
+<td>lowLatency</td>
+<td>boolean</td>
+<td>Set the Low Latency mode</td>
+<td>false</td>
+</tr>
+<tr>
+<td>outputBufferSize</td>
+<td>int</td>
+<td>The ouput buffer size to use</td>
+<td>8</td>
+</tr>
+<tr>
+<td>receiveThreshold</td>
+<td>int</td>
+<td>Set the receive threshold in byte (set it to -1 for disable)</td>
+<td>-1</td>
+</tr>
+</tbody>
+</table>
<div class="nav">
Modified:
websites/staging/mina/trunk/content/mina-project/userguide/ch4-session/ch4.2-session-statistics.html
==============================================================================
---
websites/staging/mina/trunk/content/mina-project/userguide/ch4-session/ch4.2-session-statistics.html
(original)
+++
websites/staging/mina/trunk/content/mina-project/userguide/ch4-session/ch4.2-session-statistics.html
Tue Sep 20 22:09:16 2016
@@ -183,17 +183,78 @@ h2:hover > .headerlink, h3:hover > .head
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
<h1 id="chapter-42-session-statistics">Chapter 4.2 - Session Statistics<a
class="headerlink" href="#chapter-42-session-statistics" title="Permanent
link">¶</a></h1>
<p>We keep some statistics in each sessions about what's going on. Not all
those statistics are computed fr every message though : some of them are
computed on demand.</p>
-<p>|| Parameter || Type || Description || automatic ||
-| readBytes | long | The total number of bytes read since the session was
created | yes |
-| readBytesThroughput | double | The number of bytes read per second in the
last interval | no |
-| readMessages | long | The total number of messages read since the session
was created | yes |
-| readMessagesThroughput | double | The number of messages read per second in
the last interval | no |
-| scheduledWriteBytes | AtomicInteger | The number of bytes waiting to be
written | yes |
-| scheduledWriteMessages | AtomicInteger | The number of messages waiting to
be written | yes |
-| writtenBytes | long | The total number of bytes written since the session
was created | yes |
-| writtenBytesThroughput | double | The number of bytes written per second in
the last interval | no |
-| writtenMessages | long | The total number of messages written since the
session was created | yes |
-| writtenMessagesThroughput | double | The number of messages written per
second in the last interval | no |</p>
+<table class="table">
+<thead>
+<tr>
+<th>Parameter</th>
+<th>type</th>
+<th>Description</th>
+<th>automatic</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>readBytes</td>
+<td>long</td>
+<td>The total number of bytes read since the session was created</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>readBytesThroughput</td>
+<td>double</td>
+<td>The number of bytes read per second in the last interval</td>
+<td>no</td>
+</tr>
+<tr>
+<td>readMessages</td>
+<td>long</td>
+<td>The total number of messages read since the session was created</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>readMessagesThroughput</td>
+<td>double</td>
+<td>The number of messages read per second in the last interval</td>
+<td>no</td>
+</tr>
+<tr>
+<td>scheduledWriteBytes</td>
+<td>AtomicInteger</td>
+<td>The number of bytes waiting to be written</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>scheduledWriteMessages</td>
+<td>AtomicInteger</td>
+<td>The number of messages waiting to be written</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>writtenBytes</td>
+<td>long</td>
+<td>The total number of bytes written since the session was created</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>writtenBytesThroughput</td>
+<td>double</td>
+<td>The number of bytes written per second in the last interval</td>
+<td>no</td>
+</tr>
+<tr>
+<td>writtenMessages</td>
+<td>long</td>
+<td>The total number of messages written since the session was created</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>writtenMessagesThroughput</td>
+<td>double</td>
+<td>The number of messages written per second in the last interval</td>
+<td>no</td>
+</tr>
+</tbody>
+</table>
<p>All those parameters can be read using getters.</p>
