directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From trus...@apache.org
Subject svn commit: r165129 - in /directory/network/trunk/src/java/org/apache/mina: io/ protocol/ protocol/vmpipe/
Date Thu, 28 Apr 2005 11:28:42 GMT
Author: trustin
Date: Thu Apr 28 04:28:41 2005
New Revision: 165129

URL: http://svn.apache.org/viewcvs?rev=165129&view=rev
Log:
* Added some JavaDocs to newly added code

Modified:
    directory/network/trunk/src/java/org/apache/mina/io/IoSessionFilterChain.java
    directory/network/trunk/src/java/org/apache/mina/io/IoSessionManager.java
    directory/network/trunk/src/java/org/apache/mina/io/IoSessionManagerFilterChain.java
    directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionFilterChain.java
    directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManager.java
    directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManagerFilterChain.java
    directory/network/trunk/src/java/org/apache/mina/protocol/vmpipe/VmPipeIdleStatusChecker.java

Modified: directory/network/trunk/src/java/org/apache/mina/io/IoSessionFilterChain.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/io/IoSessionFilterChain.java?rev=165129&r1=165128&r2=165129&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/io/IoSessionFilterChain.java (original)
+++ directory/network/trunk/src/java/org/apache/mina/io/IoSessionFilterChain.java Thu Apr
28 04:28:41 2005
@@ -1,23 +1,46 @@
+/*
+ *   @(#) $Id$
+ *
+ *   Copyright 2004 The Apache Software Foundation
+ *
+ *   Licensed 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.io;
 
 import org.apache.mina.common.ByteBuffer;
 
 /**
- * An {@link IoHandlerFilterChain} for datagram transport (UDP/IP).
+ * An {@link IoHandlerFilterChain} that forwards <tt>filterWrite</tt>
+ * requests to the specified {@link IoSessionManagerFilterChain}.
+ * <p>
+ * This filter chain is used by implementations of {@link IoSession}s.
  * 
- * @author The Apache Directory Project
+ * @author The Apache Directory Project (dev@directory.apache.org)
+ * @author Trustin Lee (trustin@apache.org)
+ * @version $Rev$, $Date$
  */
 public class IoSessionFilterChain extends AbstractIoHandlerFilterChain {
 
-    private final IoSessionManagerFilterChain prevChain;
+    private final IoSessionManagerFilterChain managerChain;
 
-    public IoSessionFilterChain( IoSessionManagerFilterChain prevChain )
+    public IoSessionFilterChain( IoSessionManagerFilterChain managerChain )
     {
-        this.prevChain = prevChain;
+        this.managerChain = managerChain;
     }
 
     protected void doWrite( IoSession session, ByteBuffer buf, Object marker )
     {
-        prevChain.filterWrite( session, buf, marker );
+        managerChain.filterWrite( session, buf, marker );
     }
 }

Modified: directory/network/trunk/src/java/org/apache/mina/io/IoSessionManager.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/io/IoSessionManager.java?rev=165129&r1=165128&r2=165129&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/io/IoSessionManager.java (original)
+++ directory/network/trunk/src/java/org/apache/mina/io/IoSessionManager.java Thu Apr 28 04:28:41
2005
@@ -1,9 +1,28 @@
+/*
+ *   @(#) $Id$
+ *
+ *   Copyright 2004 The Apache Software Foundation
+ *
+ *   Licensed 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.io;
 
 import org.apache.mina.common.SessionManager;
+
 /**
- * TODO document me
- * 
+ * A {@link SessionManager} for I/O layer.
+ * <p>
  * {@link IoHandlerFilter}s can be added and removed at any time to filter
  * events just like Servlet filters and they are effective immediately.
  * 
@@ -12,5 +31,9 @@
  * @version $Rev$, $Date$
  */
 public interface IoSessionManager extends SessionManager {
+    /**
+     * Returns the filter chain that filters all events which is related
+     * with sessions this manager manages.
+     */
     IoHandlerFilterChain getFilterChain();
 }

Modified: directory/network/trunk/src/java/org/apache/mina/io/IoSessionManagerFilterChain.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/io/IoSessionManagerFilterChain.java?rev=165129&r1=165128&r2=165129&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/io/IoSessionManagerFilterChain.java (original)
+++ directory/network/trunk/src/java/org/apache/mina/io/IoSessionManagerFilterChain.java Thu
Apr 28 04:28:41 2005
@@ -1,12 +1,36 @@
+/*
+ *   @(#) $Id$
+ *
+ *   Copyright 2004 The Apache Software Foundation
+ *
+ *   Licensed 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.io;
 
 import org.apache.mina.common.ByteBuffer;
 import org.apache.mina.common.IdleStatus;
 
 /**
- * An {@link IoHandlerFilterChain} for datagram transport (UDP/IP).
+ * An {@link IoHandlerFilterChain} that forwards all events
+ * except <tt>filterWrite</tt> to the {@link IoSessionFilterChain}
+ * of the recipient session.
+ * <p>
+ * This filter chain is used by implementations of {@link IoSessionManager}s.
  * 
- * @author The Apache Directory Project
+ * @author The Apache Directory Project (dev@directory.apache.org)
+ * @author Trustin Lee (trustin@apache.org)
+ * @version $Rev$, $Date$
  */
 public abstract class IoSessionManagerFilterChain extends AbstractIoHandlerFilterChain {
 

Modified: directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionFilterChain.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionFilterChain.java?rev=165129&r1=165128&r2=165129&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionFilterChain.java
(original)
+++ directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionFilterChain.java
Thu Apr 28 04:28:41 2005
@@ -1,19 +1,48 @@
+/*
+ *   @(#) $Id$
+ *
+ *   Copyright 2004 The Apache Software Foundation
+ *
+ *   Licensed 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.protocol;
 
+import org.apache.mina.io.IoHandlerFilterChain;
+import org.apache.mina.io.IoSession;
+import org.apache.mina.io.IoSessionManagerFilterChain;
+
 /**
- * TODO document me
+ * An {@link IoHandlerFilterChain} that forwards <tt>filterWrite</tt>
+ * requests to the specified {@link IoSessionManagerFilterChain}.
+ * <p>
+ * This filter chain is used by implementations of {@link IoSession}s.
+ * 
+ * @author The Apache Directory Project (dev@directory.apache.org)
+ * @author Trustin Lee (trustin@apache.org)
+ * @version $Rev$, $Date$
  */
 public class ProtocolSessionFilterChain extends AbstractProtocolHandlerFilterChain {
 
-    private final ProtocolSessionManagerFilterChain prevChain;
+    private final ProtocolSessionManagerFilterChain managerChain;
 
-    public ProtocolSessionFilterChain( ProtocolSessionManagerFilterChain prevChain )
+    public ProtocolSessionFilterChain( ProtocolSessionManagerFilterChain managerChain )
     {
-        this.prevChain = prevChain;
+        this.managerChain = managerChain;
     }
 
     protected void doWrite( ProtocolSession session, Object message )
     {
-        prevChain.filterWrite( session, message );
+        managerChain.filterWrite( session, message );
     }
 }

Modified: directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManager.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManager.java?rev=165129&r1=165128&r2=165129&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManager.java
(original)
+++ directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManager.java
Thu Apr 28 04:28:41 2005
@@ -1,9 +1,27 @@
+/*
+ *   @(#) $Id$
+ *
+ *   Copyright 2004 The Apache Software Foundation
+ *
+ *   Licensed 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.protocol;
 
 import org.apache.mina.common.SessionManager;
 
 /**
- * TODO document me.
+ * A {@link SessionManager} for Protocol layer.
  * <p>
  * {@link ProtocolHandlerFilter}s can be added and removed at any time to filter
  * events just like Servlet filters and they are effective immediately.
@@ -11,8 +29,11 @@
  * @author The Apache Directory Project (dev@directory.apache.org)
  * @author Trustin Lee (trustin@apache.org)
  * @version $Rev$, $Date$
- *
  */
 public interface ProtocolSessionManager extends SessionManager {
+    /**
+     * Returns the filter chain that filters all events which is related
+     * with sessions this manager manages.
+     */
     ProtocolHandlerFilterChain getFilterChain();
 }

Modified: directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManagerFilterChain.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManagerFilterChain.java?rev=165129&r1=165128&r2=165129&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManagerFilterChain.java
(original)
+++ directory/network/trunk/src/java/org/apache/mina/protocol/ProtocolSessionManagerFilterChain.java
Thu Apr 28 04:28:41 2005
@@ -1,11 +1,35 @@
+/*
+ *   @(#) $Id$
+ *
+ *   Copyright 2004 The Apache Software Foundation
+ *
+ *   Licensed 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.protocol;
 
 import org.apache.mina.common.IdleStatus;
 
 /**
- * TODO document me
+ * An {@link ProtocolHandlerFilterChain} that forwards all events
+ * except <tt>filterWrite</tt> to the {@link ProtocolSessionFilterChain}
+ * of the recipient session.
+ * <p>
+ * This filter chain is used by implementations of {@link ProtocolSessionManager}s.
  * 
- * @author The Apache Directory Project
+ * @author The Apache Directory Project (dev@directory.apache.org)
+ * @author Trustin Lee (trustin@apache.org)
+ * @version $Rev$, $Date$
  */
 public abstract class ProtocolSessionManagerFilterChain extends AbstractProtocolHandlerFilterChain
{
 

Modified: directory/network/trunk/src/java/org/apache/mina/protocol/vmpipe/VmPipeIdleStatusChecker.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/protocol/vmpipe/VmPipeIdleStatusChecker.java?rev=165129&r1=165128&r2=165129&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/protocol/vmpipe/VmPipeIdleStatusChecker.java
(original)
+++ directory/network/trunk/src/java/org/apache/mina/protocol/vmpipe/VmPipeIdleStatusChecker.java
Thu Apr 28 04:28:41 2005
@@ -11,7 +11,7 @@
 import org.apache.mina.common.SessionConfig;
 
 /**
- * TODO Document me.
+ * Dectects idle sessions and fires <tt>sessionIdle</tt> events to them. 
  * 
  * @author Trustin Lee (trustin@apache.org)
  * @version $Rev$, $Date$



Mime
View raw message