Author: jvermillard
Date: Tue Jul 15 14:53:41 2008
New Revision: 677064
URL: http://svn.apache.org/viewvc?rev=677064&view=rev
Log:
AbsztractPollingIoProcessor javadoc (to be continued)
Modified:
mina/trunk/core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java
Modified:
mina/trunk/core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java?rev=677064&r1=677063&r2=677064&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java
Tue Jul 15 14:53:41 2008
@@ -39,6 +39,7 @@
import org.apache.mina.core.service.IoProcessor;
import org.apache.mina.core.session.AbstractIoSession;
import org.apache.mina.core.session.IdleStatusChecker;
+import org.apache.mina.core.session.IoSession;
import org.apache.mina.core.session.IoSessionConfig;
import org.apache.mina.core.write.WriteRequest;
import org.apache.mina.core.write.WriteRequestQueue;
@@ -48,6 +49,8 @@
/**
* An abstract implementation of [EMAIL PROTECTED] IoProcessor} which helps
* transport developers to write an [EMAIL PROTECTED] IoProcessor} easily.
+ * This class is in charge of active polling a set of [EMAIL PROTECTED]
IoSession}
+ * and trigger events when some I/O operation is possible.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
@@ -82,6 +85,12 @@
private volatile boolean disposed;
private final DefaultIoFuture disposalFuture = new DefaultIoFuture(null);
+ /**
+ * Create an [EMAIL PROTECTED] AbstractPollingIoProcessor} with the given
[EMAIL PROTECTED] Executor}
+ * for handling I/Os events.
+ *
+ * @param executor the [EMAIL PROTECTED] Executor} for handling I/O events
+ */
protected AbstractPollingIoProcessor(Executor executor) {
if (executor == null) {
throw new NullPointerException("executor");
@@ -159,6 +168,11 @@
disposed = true;
}
+ /**
+ * Dispose the resources used by this [EMAIL PROTECTED] IoProcessor} for
polling
+ * the client connections
+ * @throws Exception if some low level IO error occurs
+ */
protected abstract void dispose0() throws Exception;
/**
@@ -168,14 +182,38 @@
* @throws Exception if some low level IO error occurs
*/
protected abstract boolean select(int timeout) throws Exception;
+
+ /**
+ * Say if the list of [EMAIL PROTECTED] IoSession} polled by this [EMAIL
PROTECTED] IoProcessor}
+ * is empty
+ * @return true if at least a session is managed by this [EMAIL PROTECTED]
IoProcessor}
+ */
protected abstract boolean isSelectorEmpty();
/**
* Interrupt the [EMAIL PROTECTED] AbstractPollingIoProcessor#select(int)
call.
*/
protected abstract void wakeup();
+
+ /**
+ * Get an [EMAIL PROTECTED] Iterator} for the list of [EMAIL PROTECTED]
IoSession} polled by this
+ * [EMAIL PROTECTED] IoProcessor}
+ * @return [EMAIL PROTECTED] Iterator} of [EMAIL PROTECTED] IoSession}
+ */
protected abstract Iterator<T> allSessions();
+
+ /**
+ * Get an [EMAIL PROTECTED] Iterator} for the list of [EMAIL PROTECTED]
IoSession} found selected
+ * by the last call of [EMAIL PROTECTED]
AbstractPollingIoProcessor#select(int)
+ * @return [EMAIL PROTECTED] Iterator} of [EMAIL PROTECTED] IoSession}
read for I/Os operation
+ */
protected abstract Iterator<T> selectedSessions();
+
+ /**
+ * Get the sate of a session (preparing, open, closed)
+ * @param session the [EMAIL PROTECTED] IoSession} to inspect
+ * @return the state of the session
+ */
protected abstract SessionState state(T session);
/**
@@ -222,9 +260,30 @@
*/
protected abstract boolean isInterestedInWrite(T session);
+ /**
+ * Initialize the polling of a session. Add it to the polling process.
+ * @param session the [EMAIL PROTECTED] IoSession} to add to the polling
+ * @throws Exception any exception thrown by the underlying system calls
+ */
protected abstract void init(T session) throws Exception;
+
+ /**
+ * Destroy the underlying client socket handle
+ * @param session the [EMAIL PROTECTED] IoSession}
+ * @throws Exception any exception thrown by the underlying system calls
+ */
protected abstract void destroy(T session) throws Exception;
+
+ /**
+ * Reads a sequence of bytes from a [EMAIL PROTECTED] IoSession} into the
given [EMAIL PROTECTED] IoBuffer}.
+ * Is called when the session was found ready for readying.
+ * @param session the session to read
+ * @param buf the buffer to fill
+ * @return the number of bytes read
+ * @throws Exception any exception thrown by the underlying system calls
+ */
protected abstract int read(T session, IoBuffer buf) throws Exception;
+
protected abstract int write(T session, IoBuffer buf, int length) throws
Exception;
protected abstract int transferFile(T session, FileRegion region, int
length) throws Exception;
