You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by re...@apache.org on 2015/04/16 15:37:05 UTC
svn commit: r1674070 - in /tomcat/trunk/java/org/apache/tomcat/util/net:
AprEndpoint.java Nio2Endpoint.java NioEndpoint.java SocketWrapperBase.java
Author: remm
Date: Thu Apr 16 13:37:05 2015
New Revision: 1674070
URL: http://svn.apache.org/r1674070
Log:
Since nobody seems to object for now, pull up NIO2 style API and add stubs for APR and NIO.
Modified:
tomcat/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java
tomcat/trunk/java/org/apache/tomcat/util/net/Nio2Endpoint.java
tomcat/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java
tomcat/trunk/java/org/apache/tomcat/util/net/SocketWrapperBase.java
Modified: tomcat/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java?rev=1674070&r1=1674069&r2=1674070&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java Thu Apr 16 13:37:05 2015
@@ -20,6 +20,7 @@ import java.io.EOFException;
import java.io.IOException;
import java.net.SocketTimeoutException;
import java.nio.ByteBuffer;
+import java.nio.channels.CompletionHandler;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
@@ -28,6 +29,7 @@ import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.Executor;
import java.util.concurrent.RejectedExecutionException;
+import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock;
@@ -2892,5 +2894,31 @@ public class AprEndpoint extends Abstrac
((AprEndpoint)getEndpoint()).getSSLVerifyDepth());
SSLSocket.renegotiate(socket);
}
+
+
+ @Override
+ public boolean isWritePending() {
+ return false;
+ }
+
+
+ @Override
+ public <A> CompletionState read(ByteBuffer[] dsts, int offset,
+ int length, boolean block, long timeout, TimeUnit unit,
+ A attachment, CompletionCheck check,
+ CompletionHandler<Long, ? super A> handler) {
+ // TODO Auto-generated method stub
+ throw new UnsupportedOperationException();
+ }
+
+ @Override
+ public <A> CompletionState write(ByteBuffer[] srcs, int offset,
+ int length, boolean block, long timeout, TimeUnit unit,
+ A attachment, CompletionCheck check,
+ CompletionHandler<Long, ? super A> handler) {
+ // TODO Auto-generated method stub
+ throw new UnsupportedOperationException();
+ }
+
}
}
Modified: tomcat/trunk/java/org/apache/tomcat/util/net/Nio2Endpoint.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/Nio2Endpoint.java?rev=1674070&r1=1674069&r2=1674070&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/Nio2Endpoint.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/Nio2Endpoint.java Thu Apr 16 13:37:05 2015
@@ -957,59 +957,6 @@ public class Nio2Endpoint extends Abstra
}
}
- // TODO: NIO2 style scatter/gather methods.
-
- public enum CompletionState {
- /**
- * Operation is still pending.
- */
- PENDING,
- /**
- * The operation completed inline.
- */
- INLINE,
- /**
- * The operation completed, but not inline.
- */
- DONE
- }
-
- public enum CompletionHandlerCall {
- /**
- * Operation should continue, the completion handler shouldn't be
- * called.
- */
- CONTINUE,
- /**
- * The operation completed but the completion handler shouldn't be
- * called.
- */
- NONE,
- /**
- * The operation is complete, the completion handler should be
- * called.
- */
- DONE
- }
-
- public interface CompletionCheck {
- /**
- * Return true if enough data has been read or written and the
- * handler should be notified. Return false if the IO is
- * incomplete (data has not been fully written while it should,
- * or more data read is needed for further processing) and should
- * be continued before the completion handler is called.
- *
- * @param state of the operation (done or done inline since the
- * IO call is done)
- * @param buffers ByteBuffer[] that has been passed to the
- * original IO call
- * @param offset that has been passed to the original IO call
- * @param length that has been passed to the original IO call
- */
- public CompletionHandlerCall callHandler(CompletionState state, ByteBuffer[] buffers, int offset, int length);
- }
-
/**
* Internal state tracker for scatter/gather operations.
*/
@@ -1140,92 +1087,7 @@ public class Nio2Endpoint extends Abstra
}
}
- /**
- * This utility CompletionCheck will cause the write to fully write
- * all remaining data. If the operation completes inline, the
- * completion handler will not be called.
- */
- public static final CompletionCheck COMPLETE_WRITE = new CompletionCheck() {
- @Override
- public CompletionHandlerCall callHandler(CompletionState state, ByteBuffer[] buffers, int offset, int length) {
- for (int i = 0; i < offset; i++) {
- if (buffers[i].remaining() > 0) {
- return CompletionHandlerCall.CONTINUE;
- }
- }
- return (state == CompletionState.DONE) ? CompletionHandlerCall.DONE : CompletionHandlerCall.NONE;
- }
- };
-
- /**
- * This utility CompletionCheck will cause the completion handler
- * to be called once some data has been read. If the operation
- * completes inline, the completion handler will not be called.
- */
- public static final CompletionCheck READ_DATA = new CompletionCheck() {
- @Override
- public CompletionHandlerCall callHandler(CompletionState state, ByteBuffer[] buffers, int offset, int length) {
- return (state == CompletionState.DONE) ? CompletionHandlerCall.DONE : CompletionHandlerCall.NONE;
- }
- };
-
- /**
- * Scatter read. The completion handler will be called once some
- * data has been read or an error occurred. If a CompletionCheck
- * object has been provided, the completion handler will only be
- * called if the callHandler method returned true. If no
- * CompletionCheck object has been provided, the ddefault NIO2
- * behavior is used: the completion handler will be called as soon
- * as some data has been read, even if the read has completed inline.
- *
- * @param block true to block until any pending read is done, if the
- * timeout occurs and a read is still pending, a
- * ReadPendingException will be thrown; false to
- * not block but any pending read operation will cause
- * a ReadPendingException
- * @param timeout
- * @param unit
- * @param attachment
- * @param check for the IO operation completion
- * @param handler to call when the IO is complete
- * @param dsts buffers
- * @return the completion state (done, done inline, or still pending)
- */
- // FIXME: @Override
- public <A> CompletionState read(boolean block, long timeout, TimeUnit unit, A attachment,
- CompletionCheck check, CompletionHandler<Long, ? super A> handler,
- ByteBuffer... dsts) {
- if (dsts == null) {
- throw new IllegalArgumentException();
- }
- return read(dsts, 0, dsts.length, block, timeout, unit, attachment, check, handler);
- }
-
- /**
- * Scatter read. The completion handler will be called once some
- * data has been read or an error occurred. If a CompletionCheck
- * object has been provided, the completion handler will only be
- * called if the callHandler method returned true. If no
- * CompletionCheck object has been provided, the ddefault NIO2
- * behavior is used: the completion handler will be called as soon
- * as some data has been read, even if the read has completed inline.
- *
- * @param dsts buffers
- * @param offset in the buffer array
- * @param length in the buffer array
- * @param block true to block until any pending read is done, if the
- * timeout occurs and a read is still pending, a
- * ReadPendingException will be thrown; false to
- * not block but any pending read operation will cause
- * a ReadPendingException
- * @param timeout
- * @param unit
- * @param attachment
- * @param check for the IO operation completion
- * @param handler to call when the IO is complete
- * @return the completion state (done, done inline, or still pending)
- */
- // FIXME: @Override
+ @Override
public <A> CompletionState read(ByteBuffer[] dsts, int offset, int length,
boolean block, long timeout, TimeUnit unit, A attachment,
CompletionCheck check, CompletionHandler<Long, ? super A> handler) {
@@ -1244,72 +1106,14 @@ public class Nio2Endpoint extends Abstra
return state.state;
}
- // FIXME: @Override
+ @Override
public boolean isWritePending() {
synchronized (writeCompletionHandler) {
return writePending.availablePermits() == 0;
}
}
- /**
- * Gather write. The completion handler will be called once some
- * data has been written or an error occurred. If a CompletionCheck
- * object has been provided, the completion handler will only be
- * called if the callHandler method returned true. If no
- * CompletionCheck object has been provided, the ddefault NIO2
- * behavior is used: the completion handler will be called, even
- * if the write is incomplete and data remains in the buffers, or
- * if the write completed inline.
- *
- * @param block true to block until any pending write is done, if the
- * timeout occurs and a write is still pending, a
- * WritePendingException will be thrown; false to
- * not block but any pending write operation will cause
- * a WritePendingException
- * @param timeout
- * @param unit
- * @param attachment
- * @param check for the IO operation completion
- * @param handler to call when the IO is complete
- * @param srcs buffers
- * @return the completion state (done, done inline, or still pending)
- */
- // FIXME: @Override
- public <A> CompletionState write(boolean block, long timeout, TimeUnit unit, A attachment,
- CompletionCheck check, CompletionHandler<Long, ? super A> handler,
- ByteBuffer... srcs) {
- if (srcs == null) {
- throw new IllegalArgumentException();
- }
- return write(srcs, 0, srcs.length, block, timeout, unit, attachment, check, handler);
- }
-
- /**
- * Gather write. The completion handler will be called once some
- * data has been written or an error occurred. If a CompletionCheck
- * object has been provided, the completion handler will only be
- * called if the callHandler method returned true. If no
- * CompletionCheck object has been provided, the ddefault NIO2
- * behavior is used: the completion handler will be called, even
- * if the write is incomplete and data remains in the buffers, or
- * if the write completed inline.
- *
- * @param srcs buffers
- * @param offset in the buffer array
- * @param length in the buffer array
- * @param block true to block until any pending write is done, if the
- * timeout occurs and a write is still pending, a
- * WritePendingException will be thrown; false to
- * not block but any pending write operation will cause
- * a WritePendingException
- * @param timeout
- * @param unit
- * @param attachment
- * @param check for the IO operation completion
- * @param handler to call when the IO is complete
- * @return the completion state (done, done inline, or still pending)
- */
- // FIXME: @Override
+ @Override
public <A> CompletionState write(ByteBuffer[] srcs, int offset, int length,
boolean block, long timeout, TimeUnit unit, A attachment,
CompletionCheck check, CompletionHandler<Long, ? super A> handler) {
@@ -1328,8 +1132,6 @@ public class Nio2Endpoint extends Abstra
return state.state;
}
- // TODO: End NIO2 style scatter/gather methods.
-
/* Callers of this method must:
* - have acquired the readPending semaphore
* - have acquired a lock on readCompletionHandler
Modified: tomcat/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java?rev=1674070&r1=1674069&r2=1674070&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java Thu Apr 16 13:37:05 2015
@@ -26,6 +26,7 @@ import java.net.Socket;
import java.net.SocketTimeoutException;
import java.nio.ByteBuffer;
import java.nio.channels.CancelledKeyException;
+import java.nio.channels.CompletionHandler;
import java.nio.channels.FileChannel;
import java.nio.channels.SelectionKey;
import java.nio.channels.Selector;
@@ -1499,6 +1500,29 @@ public class NioEndpoint extends Abstrac
}
}
}
+
+ @Override
+ public boolean isWritePending() {
+ return false;
+ }
+
+ @Override
+ public <A> CompletionState read(ByteBuffer[] dsts, int offset,
+ int length, boolean block, long timeout, TimeUnit unit,
+ A attachment, CompletionCheck check,
+ CompletionHandler<Long, ? super A> handler) {
+ // TODO Auto-generated method stub
+ throw new UnsupportedOperationException();
+ }
+
+ @Override
+ public <A> CompletionState write(ByteBuffer[] srcs, int offset,
+ int length, boolean block, long timeout, TimeUnit unit,
+ A attachment, CompletionCheck check,
+ CompletionHandler<Long, ? super A> handler) {
+ // TODO Auto-generated method stub
+ throw new UnsupportedOperationException();
+ }
}
Modified: tomcat/trunk/java/org/apache/tomcat/util/net/SocketWrapperBase.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/SocketWrapperBase.java?rev=1674070&r1=1674069&r2=1674070&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/SocketWrapperBase.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/SocketWrapperBase.java Thu Apr 16 13:37:05 2015
@@ -18,10 +18,12 @@ package org.apache.tomcat.util.net;
import java.io.IOException;
import java.nio.ByteBuffer;
+import java.nio.channels.CompletionHandler;
import java.util.Iterator;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.LinkedBlockingDeque;
+import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock;
@@ -268,6 +270,7 @@ public abstract class SocketWrapperBase<
public Object getWriteThreadLock() { return writeThreadLock; }
public SocketBufferHandler getSocketBufferHandler() { return socketBufferHandler; }
public abstract boolean isReadPending();
+ public abstract boolean isWritePending();
public boolean hasDataToWrite() {
return !socketBufferHandler.isWriteBufferEmpty() || bufferedWrites.size() > 0;
@@ -646,6 +649,210 @@ public abstract class SocketWrapperBase<
}
+ // ------------------------------------------------------- NIO 2 style APIs
+
+
+ public enum CompletionState {
+ /**
+ * Operation is still pending.
+ */
+ PENDING,
+ /**
+ * The operation completed inline.
+ */
+ INLINE,
+ /**
+ * The operation completed, but not inline.
+ */
+ DONE
+ }
+
+ public enum CompletionHandlerCall {
+ /**
+ * Operation should continue, the completion handler shouldn't be
+ * called.
+ */
+ CONTINUE,
+ /**
+ * The operation completed but the completion handler shouldn't be
+ * called.
+ */
+ NONE,
+ /**
+ * The operation is complete, the completion handler should be
+ * called.
+ */
+ DONE
+ }
+
+ public interface CompletionCheck {
+ /**
+ * Return true if enough data has been read or written and the
+ * handler should be notified. Return false if the IO is
+ * incomplete (data has not been fully written while it should,
+ * or more data read is needed for further processing) and should
+ * be continued before the completion handler is called.
+ *
+ * @param state of the operation (done or done inline since the
+ * IO call is done)
+ * @param buffers ByteBuffer[] that has been passed to the
+ * original IO call
+ * @param offset that has been passed to the original IO call
+ * @param length that has been passed to the original IO call
+ */
+ public CompletionHandlerCall callHandler(CompletionState state, ByteBuffer[] buffers, int offset, int length);
+ }
+
+ /**
+ * This utility CompletionCheck will cause the write to fully write
+ * all remaining data. If the operation completes inline, the
+ * completion handler will not be called.
+ */
+ public static final CompletionCheck COMPLETE_WRITE = new CompletionCheck() {
+ @Override
+ public CompletionHandlerCall callHandler(CompletionState state, ByteBuffer[] buffers, int offset, int length) {
+ for (int i = 0; i < offset; i++) {
+ if (buffers[i].remaining() > 0) {
+ return CompletionHandlerCall.CONTINUE;
+ }
+ }
+ return (state == CompletionState.DONE) ? CompletionHandlerCall.DONE : CompletionHandlerCall.NONE;
+ }
+ };
+
+ /**
+ * This utility CompletionCheck will cause the completion handler
+ * to be called once some data has been read. If the operation
+ * completes inline, the completion handler will not be called.
+ */
+ public static final CompletionCheck READ_DATA = new CompletionCheck() {
+ @Override
+ public CompletionHandlerCall callHandler(CompletionState state, ByteBuffer[] buffers, int offset, int length) {
+ return (state == CompletionState.DONE) ? CompletionHandlerCall.DONE : CompletionHandlerCall.NONE;
+ }
+ };
+
+ /**
+ * Scatter read. The completion handler will be called once some
+ * data has been read or an error occurred. If a CompletionCheck
+ * object has been provided, the completion handler will only be
+ * called if the callHandler method returned true. If no
+ * CompletionCheck object has been provided, the default NIO2
+ * behavior is used: the completion handler will be called as soon
+ * as some data has been read, even if the read has completed inline.
+ *
+ * @param block true to block until any pending read is done, if the
+ * timeout occurs and a read is still pending, a
+ * ReadPendingException will be thrown; false to
+ * not block but any pending read operation will cause
+ * a ReadPendingException
+ * @param timeout
+ * @param unit
+ * @param attachment
+ * @param check for the IO operation completion
+ * @param handler to call when the IO is complete
+ * @param dsts buffers
+ * @return the completion state (done, done inline, or still pending)
+ */
+ public <A> CompletionState read(boolean block, long timeout, TimeUnit unit, A attachment,
+ CompletionCheck check, CompletionHandler<Long, ? super A> handler,
+ ByteBuffer... dsts) {
+ if (dsts == null) {
+ throw new IllegalArgumentException();
+ }
+ return read(dsts, 0, dsts.length, block, timeout, unit, attachment, check, handler);
+ }
+
+ /**
+ * Scatter read. The completion handler will be called once some
+ * data has been read or an error occurred. If a CompletionCheck
+ * object has been provided, the completion handler will only be
+ * called if the callHandler method returned true. If no
+ * CompletionCheck object has been provided, the default NIO2
+ * behavior is used: the completion handler will be called as soon
+ * as some data has been read, even if the read has completed inline.
+ *
+ * @param dsts buffers
+ * @param offset in the buffer array
+ * @param length in the buffer array
+ * @param block true to block until any pending read is done, if the
+ * timeout occurs and a read is still pending, a
+ * ReadPendingException will be thrown; false to
+ * not block but any pending read operation will cause
+ * a ReadPendingException
+ * @param timeout
+ * @param unit
+ * @param attachment
+ * @param check for the IO operation completion
+ * @param handler to call when the IO is complete
+ * @return the completion state (done, done inline, or still pending)
+ */
+ public abstract <A> CompletionState read(ByteBuffer[] dsts, int offset, int length,
+ boolean block, long timeout, TimeUnit unit, A attachment,
+ CompletionCheck check, CompletionHandler<Long, ? super A> handler);
+
+ /**
+ * Gather write. The completion handler will be called once some
+ * data has been written or an error occurred. If a CompletionCheck
+ * object has been provided, the completion handler will only be
+ * called if the callHandler method returned true. If no
+ * CompletionCheck object has been provided, the default NIO2
+ * behavior is used: the completion handler will be called, even
+ * if the write is incomplete and data remains in the buffers, or
+ * if the write completed inline.
+ *
+ * @param block true to block until any pending write is done, if the
+ * timeout occurs and a write is still pending, a
+ * WritePendingException will be thrown; false to
+ * not block but any pending write operation will cause
+ * a WritePendingException
+ * @param timeout
+ * @param unit
+ * @param attachment
+ * @param check for the IO operation completion
+ * @param handler to call when the IO is complete
+ * @param srcs buffers
+ * @return the completion state (done, done inline, or still pending)
+ */
+ public <A> CompletionState write(boolean block, long timeout, TimeUnit unit, A attachment,
+ CompletionCheck check, CompletionHandler<Long, ? super A> handler,
+ ByteBuffer... srcs) {
+ if (srcs == null) {
+ throw new IllegalArgumentException();
+ }
+ return write(srcs, 0, srcs.length, block, timeout, unit, attachment, check, handler);
+ }
+
+ /**
+ * Gather write. The completion handler will be called once some
+ * data has been written or an error occurred. If a CompletionCheck
+ * object has been provided, the completion handler will only be
+ * called if the callHandler method returned true. If no
+ * CompletionCheck object has been provided, the default NIO2
+ * behavior is used: the completion handler will be called, even
+ * if the write is incomplete and data remains in the buffers, or
+ * if the write completed inline.
+ *
+ * @param srcs buffers
+ * @param offset in the buffer array
+ * @param length in the buffer array
+ * @param block true to block until any pending write is done, if the
+ * timeout occurs and a write is still pending, a
+ * WritePendingException will be thrown; false to
+ * not block but any pending write operation will cause
+ * a WritePendingException
+ * @param timeout
+ * @param unit
+ * @param attachment
+ * @param check for the IO operation completion
+ * @param handler to call when the IO is complete
+ * @return the completion state (done, done inline, or still pending)
+ */
+ public abstract <A> CompletionState write(ByteBuffer[] srcs, int offset, int length,
+ boolean block, long timeout, TimeUnit unit, A attachment,
+ CompletionCheck check, CompletionHandler<Long, ? super A> handler);
+
+
// --------------------------------------------------------- Utility methods
protected static int transfer(byte[] from, int offset, int length, ByteBuffer to) {
@@ -661,4 +868,5 @@ public abstract class SocketWrapperBase<
to.put(from);
from.limit(fromLimit);
}
+
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org