You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by je...@apache.org on 2016/09/17 14:18:49 UTC
mina git commit: Added some javadoc
Repository: mina
Updated Branches:
refs/heads/2.0 1af2c97ae -> 0a3742419
Added some javadoc
Project: http://git-wip-us.apache.org/repos/asf/mina/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/0a374241
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/0a374241
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/0a374241
Branch: refs/heads/2.0
Commit: 0a37424190012a8ef04a00f437c0d411e253087b
Parents: 1af2c97
Author: Jeff MAURY <je...@jeffmaury.com>
Authored: Sat Sep 17 16:18:29 2016 +0200
Committer: Jeff MAURY <je...@jeffmaury.com>
Committed: Sat Sep 17 16:18:29 2016 +0200
----------------------------------------------------------------------
.../core/session/AbstractIoSessionConfig.java | 14 ++++++++++++--
.../socket/AbstractDatagramSessionConfig.java | 18 +++++++++---------
.../socket/AbstractSocketSessionConfig.java | 7 +------
3 files changed, 22 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/0a374241/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java b/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java
index 85ef6e0..db693bf 100644
--- a/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java
+++ b/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java
@@ -25,21 +25,31 @@ package org.apache.mina.core.session;
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public abstract class AbstractIoSessionConfig implements IoSessionConfig {
-
+ /** The minimum size of the buffer used to read incoming data */
private int minReadBufferSize = 64;
-
+
+ /** The default size of the buffer used to read incoming data */
private int readBufferSize = 2048;
+ /** The maximum size of the buffer used to read incoming data */
private int maxReadBufferSize = 65536;
+ /** The delay before we notify a session that it has been idle on read. Default to infinite */
private int idleTimeForRead;
+ /** The delay before we notify a session that it has been idle on write. Default to infinite */
private int idleTimeForWrite;
+ /**
+ * The delay before we notify a session that it has been idle on read and write.
+ * Default to infinite
+ **/
private int idleTimeForBoth;
+ /** The delay to wait for a write operation to complete before bailing out */
private int writeTimeout = 60;
+ /** A flag set to true when weallow the application to do a session.read(). Default to false */
private boolean useReadOperation;
private int throughputCalculationInterval = 3;
http://git-wip-us.apache.org/repos/asf/mina/blob/0a374241/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java
index 0c0734c..0ed3b70 100644
--- a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java
+++ b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java
@@ -23,19 +23,13 @@ import org.apache.mina.core.session.AbstractIoSessionConfig;
import org.apache.mina.core.session.IoSessionConfig;
/**
- * TODO Add documentation
+ * The Datagram transport session configuration.
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionConfig implements DatagramSessionConfig {
-
- private static final boolean DEFAULT_CLOSE_ON_PORT_UNREACHABLE = true;
-
- private boolean closeOnPortUnreachable = DEFAULT_CLOSE_ON_PORT_UNREACHABLE;
-
- protected AbstractDatagramSessionConfig() {
- // Do nothing
- }
+ /** Tells if we should close the session if the port is unreachable. Default to true */
+ private boolean closeOnPortUnreachable = true;
@Override
protected void doSetAll(IoSessionConfig config) {
@@ -46,18 +40,23 @@ public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionCon
if (config instanceof AbstractDatagramSessionConfig) {
// Minimize unnecessary system calls by checking all 'propertyChanged' properties.
AbstractDatagramSessionConfig cfg = (AbstractDatagramSessionConfig) config;
+
if (cfg.isBroadcastChanged()) {
setBroadcast(cfg.isBroadcast());
}
+
if (cfg.isReceiveBufferSizeChanged()) {
setReceiveBufferSize(cfg.getReceiveBufferSize());
}
+
if (cfg.isReuseAddressChanged()) {
setReuseAddress(cfg.isReuseAddress());
}
+
if (cfg.isSendBufferSizeChanged()) {
setSendBufferSize(cfg.getSendBufferSize());
}
+
if (cfg.isTrafficClassChanged() && getTrafficClass() != cfg.getTrafficClass()) {
setTrafficClass(cfg.getTrafficClass());
}
@@ -67,6 +66,7 @@ public abstract class AbstractDatagramSessionConfig extends AbstractIoSessionCon
setReceiveBufferSize(cfg.getReceiveBufferSize());
setReuseAddress(cfg.isReuseAddress());
setSendBufferSize(cfg.getSendBufferSize());
+
if (getTrafficClass() != cfg.getTrafficClass()) {
setTrafficClass(cfg.getTrafficClass());
}
http://git-wip-us.apache.org/repos/asf/mina/blob/0a374241/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java
index f96f70c..6443e17 100644
--- a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java
+++ b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java
@@ -23,16 +23,11 @@ import org.apache.mina.core.session.AbstractIoSessionConfig;
import org.apache.mina.core.session.IoSessionConfig;
/**
- * TODO Add documentation
+ * The TCP transport session configuration.
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public abstract class AbstractSocketSessionConfig extends AbstractIoSessionConfig implements SocketSessionConfig {
-
- protected AbstractSocketSessionConfig() {
- // Do nothing
- }
-
@Override
protected final void doSetAll(IoSessionConfig config) {
if (!(config instanceof SocketSessionConfig)) {