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 2022/04/10 22:59:33 UTC
[mina] branch 2.2.X updated: Some more javadoc added
This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch 2.2.X
in repository https://gitbox.apache.org/repos/asf/mina.git
The following commit(s) were added to refs/heads/2.2.X by this push:
new e70fa1326 Some more javadoc added
e70fa1326 is described below
commit e70fa1326b4571a2da05a0f74fab756f1507d583
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Mon Apr 11 00:59:27 2022 +0200
Some more javadoc added
---
.../executor/PriorityThreadPoolExecutor.java | 77 ++++++++++++----------
.../org/apache/mina/filter/ssl/SslHandler.java | 2 +-
.../mina/filter/stream/FileRegionWriteFilter.java | 2 +-
3 files changed, 46 insertions(+), 35 deletions(-)
diff --git a/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java b/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
index c85b99eb6..5a995f961 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
@@ -19,15 +19,32 @@
*/
package org.apache.mina.filter.executor;
-import org.apache.mina.core.session.*;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.util.*;
-import java.util.concurrent.*;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Queue;
+import java.util.Set;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.ConcurrentLinkedQueue;
+import java.util.concurrent.Executors;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.PriorityBlockingQueue;
+import java.util.concurrent.RejectedExecutionHandler;
+import java.util.concurrent.SynchronousQueue;
+import java.util.concurrent.ThreadFactory;
+import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
+import org.apache.mina.core.session.AttributeKey;
+import org.apache.mina.core.session.DummySession;
+import org.apache.mina.core.session.IoEvent;
+import org.apache.mina.core.session.IoSession;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
/**
* A {@link ThreadPoolExecutor} that maintains the order of {@link IoEvent}s
* within a session (similar to {@link OrderedThreadPoolExecutor}) and allows
@@ -100,6 +117,8 @@ public class PriorityThreadPoolExecutor extends ThreadPoolExecutor {
* Creates a default ThreadPool, with default values : - minimum pool size is 0
* - maximum pool size is 16 - keepAlive set to 30 seconds - A default
* ThreadFactory - All events are accepted
+ *
+ * @param comparator The comparator used to prioritize the queue
*/
public PriorityThreadPoolExecutor(Comparator<IoSession> comparator) {
this(DEFAULT_INITIAL_THREAD_POOL_SIZE, DEFAULT_MAX_THREAD_POOL, DEFAULT_KEEP_ALIVE, TimeUnit.SECONDS,
@@ -107,12 +126,14 @@ public class PriorityThreadPoolExecutor extends ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - minimum pool size is 0
- * - keepAlive set to 30 seconds - A default ThreadFactory - All events are
- * accepted
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>minimum pool size is 0</li>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory - All events are accepted</li>
+ * </ul>
*
- * @param maximumPoolSize
- * The maximum pool size
+ * @param maximumPoolSize The maximum pool size
*/
public PriorityThreadPoolExecutor(int maximumPoolSize) {
this(DEFAULT_INITIAL_THREAD_POOL_SIZE, maximumPoolSize, DEFAULT_KEEP_ALIVE, TimeUnit.SECONDS,
@@ -186,16 +207,11 @@ public class PriorityThreadPoolExecutor extends ThreadPoolExecutor {
/**
* Creates a default ThreadPool, with default values : - A default ThreadFactory
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
- * @param keepAliveTime
- * Default duration for a thread
- * @param unit
- * Time unit used for the keepAlive value
- * @param threadFactory
- * The factory used to create threads
+ * @param corePoolSize The initial pool sizePoolSize
+ * @param maximumPoolSize The maximum pool size
+ * @param keepAliveTime Default duration for a thread
+ * @param unit Time unit used for the keepAlive value
+ * @param threadFactory The factory used to create threads
*/
public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,
ThreadFactory threadFactory) {
@@ -205,18 +221,13 @@ public class PriorityThreadPoolExecutor extends ThreadPoolExecutor {
/**
* Creates a new instance of a PrioritisedOrderedThreadPoolExecutor.
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
- * @param keepAliveTime
- * Default duration for a thread
- * @param unit
- * Time unit used for the keepAlive value
- * @param threadFactory
- * The factory used to create threads
- * @param eventQueueHandler
- * The queue used to store events
+ * @param corePoolSize The initial pool sizePoolSize
+ * @param maximumPoolSize The maximum pool size
+ * @param keepAliveTime Default duration for a thread
+ * @param unit Time unit used for the keepAlive value
+ * @param threadFactory The factory used to create threads
+ * @param eventQueueHandler The queue used to store events
+ * @param comparator The comparator used to prioritize the queue
*/
public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,
ThreadFactory threadFactory, IoEventQueueHandler eventQueueHandler, Comparator<IoSession> comparator) {
diff --git a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslHandler.java b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslHandler.java
index 04365c5f3..1e6d13735 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslHandler.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslHandler.java
@@ -36,7 +36,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Default interface for SSL exposed to the {@link SSLFilter}
+ * Default interface for SSL exposed to the {@link SslFilter}
*
* @author Jonathan Valliere
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
diff --git a/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java b/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java
index f430c3e78..840c65fdc 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java
@@ -37,7 +37,7 @@ import org.apache.mina.core.session.IoSession;
* {@link org.apache.mina.core.service.IoProcessor} but this is not always possible
* if a filter is being used that needs to modify the contents of the file
* before sending over the network (i.e. the
- * {@link org.apache.mina.filter.ssl.SSLFilter} or a data compression filter.)
+ * {@link org.apache.mina.filter.ssl.SslFilter} or a data compression filter.)
* </p>
* <p> This filter will ignore written messages which aren't {@link FileRegion}
* instances. Such messages will be passed to the next filter directly.