Author: trustin
Date: Mon Nov 5 22:24:00 2007
New Revision: 592301
URL: http://svn.apache.org/viewvc?rev=592301&view=rev
Log:
Added JavaDoc to IoSessionDataStructureFactory
Modified:
mina/trunk/core/src/main/java/org/apache/mina/common/IoSessionDataStructureFactory.java
Modified:
mina/trunk/core/src/main/java/org/apache/mina/common/IoSessionDataStructureFactory.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/IoSessionDataStructureFactory.java?rev=592301&r1=592300&r2=592301&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/common/IoSessionDataStructureFactory.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/common/IoSessionDataStructureFactory.java
Mon Nov 5 22:24:00 2007
@@ -19,6 +19,7 @@
*/
package org.apache.mina.common;
+import java.util.Comparator;
import java.util.Queue;
/**
@@ -28,6 +29,18 @@
* @version $Rev$, $Date$
*/
public interface IoSessionDataStructureFactory {
+ /**
+ * Returns an [EMAIL PROTECTED] IoSessionAttributeMap} which is going to
be associated
+ * with the specified <tt>session</tt>.
+ */
IoSessionAttributeMap getAttributeMap(IoSession session) throws Exception;
+
+ /**
+ * Returns an [EMAIL PROTECTED] Queue} of [EMAIL PROTECTED] WriteRequest}s
which is going to be
+ * associated with the specified <tt>session</tt>. Please note that the
+ * returned implementation must robust enough to deal with various types,
+ * especially when you are going to implement a priority queue which
involves
+ * [EMAIL PROTECTED] Comparator}.
+ */
Queue<WriteRequest> getWriteRequestQueue(IoSession session) throws
Exception;
}
