You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2016/12/10 07:48:56 UTC
[2/2] mina git commit: o Fixed the missing Javadocs
o Fixed the missing Javadocs
Project: http://git-wip-us.apache.org/repos/asf/mina/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/085abd57
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/085abd57
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/085abd57
Branch: refs/heads/2.0
Commit: 085abd577cda60809817d3d4bd81bffd6652b78a
Parents: 4cb03e0
Author: Emmanuel L�charny <el...@symas.com>
Authored: Sat Dec 10 08:48:42 2016 +0100
Committer: Emmanuel L�charny <el...@symas.com>
Committed: Sat Dec 10 08:48:42 2016 +0100
----------------------------------------------------------------------
.../mina/transport/serial/SerialAddress.java | 70 ++++++++++++++++++--
.../mina/transport/serial/SerialConnector.java | 24 ++++++-
.../serial/SerialPortUnavailableException.java | 8 ++-
.../transport/serial/SerialSessionConfig.java | 3 +-
4 files changed, 96 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/085abd57/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialAddress.java
----------------------------------------------------------------------
diff --git a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialAddress.java b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialAddress.java
index 7d88a72..b5af50e 100644
--- a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialAddress.java
+++ b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialAddress.java
@@ -34,20 +34,82 @@ public class SerialAddress extends SocketAddress {
private static final long serialVersionUID = 1735370510442384505L;
+ /**
+ * The number of data bits per byte
+ */
public enum DataBits {
- DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8
+ /** 5 bits per bytes */
+ DATABITS_5,
+
+ /** 6 bits per bytes */
+ DATABITS_6,
+
+ /** 7 bits per bytes */
+ DATABITS_7,
+
+ /** 8 bits per bytes */
+ DATABITS_8
}
+ /**
+ * The error detection parity in use
+ *
+ */
public enum Parity {
- NONE, ODD, EVEN, MARK, SPACE
+ /** No parity bit sent */
+ NONE,
+
+ /** Odd parity */
+ ODD,
+
+ /** Even parity */
+ EVEN,
+
+ /** Mark signal condition */
+ MARK,
+
+ /**Space signal condition */
+ SPACE
}
+ /**
+ * Stop bits in use
+ */
public enum StopBits {
- BITS_1, BITS_2, BITS_1_5
+ /** One bit */
+ BITS_1,
+
+ /** Two bits */
+ BITS_2,
+
+ /** one and half bits */
+ BITS_1_5
}
+ /**
+ * The Flow control flags
+ */
public enum FlowControl {
- NONE, RTSCTS_IN, RTSCTS_OUT, RTSCTS_IN_OUT, XONXOFF_IN, XONXOFF_OUT, XONXOFF_IN_OUT
+ /** No flow control */
+ NONE,
+
+ /** RTS/CTS IN flow control */
+ RTSCTS_IN,
+
+ /** RTS/CTS OUT flow control */
+ RTSCTS_OUT,
+
+ /** RTS/CTS IN/OUT flow control */
+ RTSCTS_IN_OUT,
+
+ /** XON/XOFF IN flow control */
+ XONXOFF_IN,
+
+ /** XON/XOFF OUT flow control */
+ XONXOFF_OUT,
+
+ /** XON/XOFF IN/OUT flow control */
+ XONXOFF_IN_OUT
}
private final String name;
http://git-wip-us.apache.org/repos/asf/mina/blob/085abd57/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialConnector.java
----------------------------------------------------------------------
diff --git a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialConnector.java b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialConnector.java
index 9ced467..066f772 100644
--- a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialConnector.java
+++ b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialConnector.java
@@ -51,10 +51,18 @@ public final class SerialConnector extends AbstractIoConnector {
private IdleStatusChecker idleChecker;
+ /**
+ * Creates a new SerialConnector instance
+ */
public SerialConnector() {
this(null);
}
+ /**
+ * Creates a new SerialConnector instance
+ *
+ * @param executor The Executor to use internally
+ */
public SerialConnector(Executor executor) {
super(new DefaultSerialSessionConfig(), executor);
log = LoggerFactory.getLogger(SerialConnector.class);
@@ -63,7 +71,6 @@ public final class SerialConnector extends AbstractIoConnector {
// we schedule the idle status checking task in this service exceutor
// it will be woke up every seconds
executeWorker(idleChecker.getNotifyingTask(), "idleStatusChecker");
-
}
@Override
@@ -78,10 +85,12 @@ public final class SerialConnector extends AbstractIoConnector {
// looping around found ports
while (portList.hasMoreElements()) {
portId = (CommPortIdentifier) portList.nextElement();
+
if (portId.getPortType() == CommPortIdentifier.PORT_SERIAL) {
if (log.isDebugEnabled()) {
log.debug("Serial port discovered : " + portId.getName());
}
+
if (portId.getName().equals(portAddress.getName())) {
try {
if (log.isDebugEnabled()) {
@@ -94,26 +103,31 @@ public final class SerialConnector extends AbstractIoConnector {
SerialSessionImpl session = new SerialSessionImpl(this, getListeners(), portAddress, serialPort);
initSession(session, future, sessionInitializer);
session.start();
+
return future;
} catch (PortInUseException e) {
if (log.isDebugEnabled()) {
log.debug("Port In Use Exception : ", e);
}
+
return DefaultConnectFuture.newFailedFuture(e);
} catch (UnsupportedCommOperationException e) {
if (log.isDebugEnabled()) {
log.debug("Comm Exception : ", e);
}
+
return DefaultConnectFuture.newFailedFuture(e);
} catch (IOException e) {
if (log.isDebugEnabled()) {
log.debug("IOException : ", e);
}
+
return DefaultConnectFuture.newFailedFuture(e);
} catch (TooManyListenersException e) {
if (log.isDebugEnabled()) {
log.debug("TooManyListenersException : ", e);
}
+
return DefaultConnectFuture.newFailedFuture(e);
}
}
@@ -123,6 +137,9 @@ public final class SerialConnector extends AbstractIoConnector {
return DefaultConnectFuture.newFailedFuture(new SerialPortUnavailableException("Serial port not found"));
}
+ /**
+ * {@inheritDoc}
+ */
@Override
protected void dispose0() throws Exception {
// stop the idle checking task
@@ -139,6 +156,7 @@ public final class SerialConnector extends AbstractIoConnector {
SerialSessionConfig config = (SerialSessionConfig) getSessionConfig();
long connectTimeout = getConnectTimeoutMillis();
+
if (connectTimeout > Integer.MAX_VALUE) {
connectTimeout = Integer.MAX_VALUE;
}
@@ -172,6 +190,10 @@ public final class SerialConnector extends AbstractIoConnector {
return idleChecker;
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public IoSessionConfig getSessionConfig() {
return sessionConfig;
}
http://git-wip-us.apache.org/repos/asf/mina/blob/085abd57/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialPortUnavailableException.java
----------------------------------------------------------------------
diff --git a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialPortUnavailableException.java b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialPortUnavailableException.java
index ae0e71a..6ada0bd 100644
--- a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialPortUnavailableException.java
+++ b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialPortUnavailableException.java
@@ -24,14 +24,18 @@ import org.apache.mina.core.RuntimeIoException;
/**
* Exception thrown when the serial port can't be open because
* it doesn't exists.
+ *
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public class SerialPortUnavailableException extends RuntimeIoException {
-
private static final long serialVersionUID = 1L;
+ /**
+ * Creates a new SerialPortUnavailableException instance
+ *
+ * @param details The error message
+ */
public SerialPortUnavailableException(String details) {
super(details);
}
-
}
http://git-wip-us.apache.org/repos/asf/mina/blob/085abd57/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java
----------------------------------------------------------------------
diff --git a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java
index f8202e3..c3c4320 100644
--- a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java
+++ b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java
@@ -25,10 +25,10 @@ import org.apache.mina.core.session.IoSessionConfig;
* An {@link IoSessionConfig} for serial transport type.
* All those parameters are extracted from rxtx.org API for more details :
* http://www.rxtx.org
+ *
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public interface SerialSessionConfig extends IoSessionConfig {
-
/**
* Gets the input buffer size. Note that this method is advisory and the underlying OS
* may choose not to report correct values for the buffer size.
@@ -82,5 +82,4 @@ public interface SerialSessionConfig extends IoSessionConfig {
* @param bytes minimal amount of byte before producing a new frame, or -1 if disabled
*/
void setReceiveThreshold(int bytes);
-
}