You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by ad...@apache.org on 2011/07/05 18:41:00 UTC
svn commit: r1143132 - in /mina/branches/3.0/core/src:
main/java/org/apache/mina/ main/java/org/apache/mina/service/client/
main/java/org/apache/mina/session/ main/java/org/apache/mina/transport/tcp/
test/java/org/apache/mina/session/
Author: adc
Date: Tue Jul 5 16:40:59 2011
New Revision: 1143132
URL: http://svn.apache.org/viewvc?rev=1143132&view=rev
Log:
Added IoFuture
Added:
mina/branches/3.0/core/src/main/java/org/apache/mina/IoFuture.java
mina/branches/3.0/core/src/main/java/org/apache/mina/IoFutureListener.java
Removed:
mina/branches/3.0/core/src/main/java/org/apache/mina/CloseFuture.java
mina/branches/3.0/core/src/main/java/org/apache/mina/ConnectFuture.java
mina/branches/3.0/core/src/main/java/org/apache/mina/IoSessionFuture.java
mina/branches/3.0/core/src/main/java/org/apache/mina/WriteFuture.java
Modified:
mina/branches/3.0/core/src/main/java/org/apache/mina/IoClient.java
mina/branches/3.0/core/src/main/java/org/apache/mina/IoSession.java
mina/branches/3.0/core/src/main/java/org/apache/mina/service/client/AbstractIoClient.java
mina/branches/3.0/core/src/main/java/org/apache/mina/session/AbstractIoSession.java
mina/branches/3.0/core/src/main/java/org/apache/mina/transport/tcp/NioTcpSession.java
mina/branches/3.0/core/src/test/java/org/apache/mina/session/AbstractIoSessionTest.java
Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/IoClient.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/IoClient.java?rev=1143132&r1=1143131&r2=1143132&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/IoClient.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/IoClient.java Tue Jul 5 16:40:59 2011
@@ -47,10 +47,10 @@ public interface IoClient extends IoServ
*
* @param remoteAddress Remote {@link SocketAddress} to connect
*
- * @return the {@link ConnectFuture} instance which is completed when the
+ * @return the {@link IoFuture} instance which is completed when the
* connection attempt initiated by this call succeeds or fails.
*/
- ConnectFuture connect(SocketAddress remoteAddress);
+ IoFuture<IoSession> connect(SocketAddress remoteAddress);
/**
* Connects to the specified remote address binding to the specified local
@@ -60,9 +60,8 @@ public interface IoClient extends IoServ
* @param localAddress Local {@link SocketAddress} to use while initiating connection to
* remote {@link SocketAddress}
*
- * @return the {@link ConnectFuture} instance which is completed when the
+ * @return the {@link IoFuture} instance which is completed when the
* connection attempt initiated by this call succeeds or fails.
*/
- ConnectFuture connect(SocketAddress remoteAddress,
- SocketAddress localAddress);
+ IoFuture<IoSession> connect(SocketAddress remoteAddress, SocketAddress localAddress);
}
Added: mina/branches/3.0/core/src/main/java/org/apache/mina/IoFuture.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/IoFuture.java?rev=1143132&view=auto
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/IoFuture.java (added)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/IoFuture.java Tue Jul 5 16:40:59 2011
@@ -0,0 +1,42 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.mina;
+
+
+import java.util.concurrent.Future;
+
+
+/**
+ * A simple extension that allows listeners to register and receive results
+ * asynchronously via registered listeners. The listeners will be called from
+ * an event pool and so any amount of significant work should not be done in
+ * this listener.
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
+ */
+public interface IoFuture<V> extends Future<V> {
+ /**
+ * Register a listener to asynchronously receive the results of the
+ * future computation.
+ *
+ * @param listener the listener to asynchronously receive the results of the future computation
+ * @return the instance of the future to allow "chaining" of registrations
+ */
+ public IoFuture<V> register(IoFutureListener<V> listener);
+}
Added: mina/branches/3.0/core/src/main/java/org/apache/mina/IoFutureListener.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/IoFutureListener.java?rev=1143132&view=auto
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/IoFutureListener.java (added)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/IoFutureListener.java Tue Jul 5 16:40:59 2011
@@ -0,0 +1,46 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.mina;
+
+/**
+ * A listener that asynchronously receives the result of a future computation.
+ * The listeners will be called from an event pool and so any amount of
+ * significant work should not be done in this listener.
+ *
+ * @author <a href="http://mina.apache.org">Apache MINA Project</a>
+ */
+public interface IoFutureListener<V> {
+ /**
+ * Called if there was an exception by the task as it was executing,
+ * {@link java.util.concurrent.ExecutionException}, or if there was
+ * an interruption while waiting for the task to complete,
+ * {@link InterruptedException}.
+ *
+ * @param e an instance of {@link InterruptedException} or {@link java.util.concurrent.ExecutionException}
+ */
+ void exception(Exception e);
+
+ /**
+ * Called when the task has completed. This method provides the result
+ * returned by the task.
+ *
+ * @param result the result returned by the task.
+ */
+ void completed(V result);
+}
Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/IoSession.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/IoSession.java?rev=1143132&r1=1143131&r2=1143132&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/IoSession.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/IoSession.java Tue Jul 5 16:40:59 2011
@@ -104,16 +104,16 @@ public interface IoSession {
/**
* Closes this session immediately or after all queued write requests are
* flushed. This operation is asynchronous. Wait for the returned
- * {@link CloseFuture} if you want to wait for the session actually closed.
+ * {@link IoFuture} if you want to wait for the session actually closed.
* Once this method has been called, no incoming request will be accepted.
*
* @param immediately
* {@code true} to close this session immediately. {@code false}
* to close this session after all queued write requests are
* flushed.
- * @return A {@link CloseFuture} that will contains the session's state
+ * @return A {@link IoFuture} that will contains the session's state
*/
- CloseFuture close(boolean immediately);
+ IoFuture<Void> close(boolean immediately);
/* READ/WRITE PAUSE MANAGEMENT */
/**
@@ -275,12 +275,12 @@ public interface IoSession {
/**
* Same as {@link IoSession#write(Object)}, but provide a
- * {@link WriteFuture} for tracking the completion of this write.
+ * {@link IoFuture} for tracking the completion of this write.
*
* @param message the message to be processed and written
- * @return the {@link WriteFuture} for tracking this asynchronous operation
+ * @return the {@link IoFuture} for tracking this asynchronous operation
*/
- public WriteFuture writeWithFuture(Object message);
+ public IoFuture<Void> writeWithFuture(Object message);
/**
* Get the {@link WriteQueue} of this session. The write queue contains the pending writes.
Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/service/client/AbstractIoClient.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/service/client/AbstractIoClient.java?rev=1143132&r1=1143131&r2=1143132&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/service/client/AbstractIoClient.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/service/client/AbstractIoClient.java Tue Jul 5 16:40:59 2011
@@ -22,8 +22,8 @@ package org.apache.mina.service.client;
import java.net.SocketAddress;
import java.util.Map;
-import org.apache.mina.ConnectFuture;
import org.apache.mina.IoClient;
+import org.apache.mina.IoFuture;
import org.apache.mina.IoServiceListener;
import org.apache.mina.IoSession;
import org.apache.mina.service.AbstractIoService;
@@ -64,12 +64,12 @@ public class AbstractIoClient extends Ab
}
@Override
- public ConnectFuture connect( SocketAddress remoteAddress ) {
+ public IoFuture<IoSession> connect( SocketAddress remoteAddress ) {
return null;
}
@Override
- public ConnectFuture connect( SocketAddress remoteAddress, SocketAddress localAddress ) {
+ public IoFuture<IoSession> connect( SocketAddress remoteAddress, SocketAddress localAddress ) {
return null;
}
Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/session/AbstractIoSession.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/session/AbstractIoSession.java?rev=1143132&r1=1143131&r2=1143132&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/session/AbstractIoSession.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/session/AbstractIoSession.java Tue Jul 5 16:40:59 2011
@@ -25,9 +25,9 @@ import java.util.concurrent.ConcurrentHa
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicLong;
+import org.apache.mina.IoFuture;
import org.apache.mina.IoService;
import org.apache.mina.IoSession;
-import org.apache.mina.WriteFuture;
import org.apache.mina.service.SelectorProcessor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -229,9 +229,9 @@ public abstract class AbstractIoSession
}
@Override
- public WriteFuture writeWithFuture(Object message) {
+ public IoFuture<Void> writeWithFuture(Object message) {
write(message);
- // TODO implements WriteFuture
+ // TODO implements IoFuture
return null;
}
Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/transport/tcp/NioTcpSession.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/transport/tcp/NioTcpSession.java?rev=1143132&r1=1143131&r2=1143132&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/transport/tcp/NioTcpSession.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/transport/tcp/NioTcpSession.java Tue Jul 5 16:40:59 2011
@@ -23,7 +23,7 @@ import java.net.InetSocketAddress;
import java.net.Socket;
import java.nio.channels.SocketChannel;
-import org.apache.mina.CloseFuture;
+import org.apache.mina.IoFuture;
import org.apache.mina.IoSessionConfig;
import org.apache.mina.service.SelectorProcessor;
import org.apache.mina.session.AbstractIoSession;
@@ -96,7 +96,7 @@ public class NioTcpSession extends Abstr
}
@Override
- public CloseFuture close(boolean immediately) {
+ public IoFuture<Void> close(boolean immediately) {
// TODO Auto-generated method stub
return null;
}
Modified: mina/branches/3.0/core/src/test/java/org/apache/mina/session/AbstractIoSessionTest.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/test/java/org/apache/mina/session/AbstractIoSessionTest.java?rev=1143132&r1=1143131&r2=1143132&view=diff
==============================================================================
--- mina/branches/3.0/core/src/test/java/org/apache/mina/session/AbstractIoSessionTest.java (original)
+++ mina/branches/3.0/core/src/test/java/org/apache/mina/session/AbstractIoSessionTest.java Tue Jul 5 16:40:59 2011
@@ -4,7 +4,7 @@ import java.net.SocketAddress;
import junit.framework.Assert;
-import org.apache.mina.CloseFuture;
+import org.apache.mina.IoFuture;
import org.apache.mina.IoService;
import org.apache.mina.IoSessionConfig;
import org.junit.Test;
@@ -17,7 +17,7 @@ public class AbstractIoSessionTest {
}
@Override
- public CloseFuture close(boolean immediately) {
+ public IoFuture<Void> close(boolean immediately) {
return null;
}