You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2014/01/27 19:37:13 UTC
svn commit: r1561778 - in
/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes: tipis/ transport/
transport/bio/ transport/bio/util/ transport/nio/
Author: markt
Date: Mon Jan 27 18:37:12 2014
New Revision: 1561778
URL: http://svn.apache.org/r1561778
Log:
Fix Javadoc warnings
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/AbstractSender.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReplicationTransmitter.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReceiver.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/PooledMultiSender.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/FastQueue.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java Mon Jan 27 18:37:12 2014
@@ -496,7 +496,6 @@ public abstract class AbstractReplicated
}
/**
- * @todo implement state transfer
* @param msg Serializable
* @return Serializable - null if no reply should be sent
*/
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java Mon Jan 27 18:37:12 2014
@@ -61,7 +61,9 @@ import org.apache.catalina.tribes.tipis.
*
* <br><br><b>REMBER TO CALL <code>breakdown()</code> or <code>finalize()</code> when you are done with the map to
* avoid memory leaks.<br><br>
- * @todo implement periodic sync/transfer thread
+ *
+ * TODO implement periodic sync/transfer thread
+ *
* @author Filip Hanik
* @version 1.0
*/
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java Mon Jan 27 18:37:12 2014
@@ -43,12 +43,14 @@ import org.apache.catalina.tribes.tipis.
*
* <br><br><b>REMBER TO CALL <code>breakdown()</code> or <code>finalize()</code> when you are done with the map to
* avoid memory leaks.<br><br>
- * @todo implement periodic sync/transfer thread
+ *
* @author Filip Hanik
* @version 1.0
*
- * @todo memberDisappeared, should do nothing except change map membership
- * by default it relocates the primary objects
+ * TODO implement periodic sync/transfer thread
+ *
+ * TODO memberDisappeared, should do nothing except change map membership
+ * by default it relocates the primary objects
*/
public class ReplicatedMap extends AbstractReplicatedMap implements RpcCallback, ChannelListener, MembershipListener {
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/AbstractSender.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/AbstractSender.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/AbstractSender.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/AbstractSender.java Mon Jan 27 18:37:12 2014
@@ -89,27 +89,13 @@ public abstract class AbstractSender imp
}
- /**
- * connect
- *
- * @throws IOException
- * @todo Implement this org.apache.catalina.tribes.transport.DataSender method
- */
+
public abstract void connect() throws IOException;
- /**
- * disconnect
- *
- * @todo Implement this org.apache.catalina.tribes.transport.DataSender method
- */
+
public abstract void disconnect();
- /**
- * keepalive
- *
- * @return boolean
- * @todo Implement this org.apache.catalina.tribes.transport.DataSender method
- */
+
public boolean keepalive() {
boolean disconnect = false;
if ( keepAliveCount >= 0 && requestCount>keepAliveCount ) disconnect = true;
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java Mon Jan 27 18:37:12 2014
@@ -92,21 +92,12 @@ public abstract class ReceiverBase imple
executor = null;
}
- /**
- * getMessageListener
- *
- * @return MessageListener
- * @todo Implement this org.apache.catalina.tribes.ChannelReceiver method
- */
+
public MessageListener getMessageListener() {
return listener;
}
- /**
- *
- * @return The port
- * @todo Implement this org.apache.catalina.tribes.ChannelReceiver method
- */
+
public int getPort() {
return port;
}
@@ -127,12 +118,7 @@ public abstract class ReceiverBase imple
return getMaxThreads();
}
- /**
- * setMessageListener
- *
- * @param listener MessageListener
- * @todo Implement this org.apache.catalina.tribes.ChannelReceiver method
- */
+
public void setMessageListener(MessageListener listener) {
this.listener = listener;
}
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReplicationTransmitter.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReplicationTransmitter.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReplicationTransmitter.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/ReplicationTransmitter.java Mon Jan 27 18:37:12 2014
@@ -73,7 +73,7 @@ public class ReplicationTransmitter impl
/**
* Send data to one member
- * @see org.apache.catalina.tribes.ClusterSender#sendMessage(org.apache.catalina.tribes.ClusterMessage, org.apache.catalina.tribes.Member)
+ * @see org.apache.catalina.tribes.ChannelSender#sendMessage(ChannelMessage, Member[])
*/
public void sendMessage(ChannelMessage message, Member[] destination) throws ChannelException {
MultiPointSender sender = getTransport();
@@ -84,7 +84,7 @@ public class ReplicationTransmitter impl
/**
* start the sender and register transmitter mbean
*
- * @see org.apache.catalina.tribes.ClusterSender#start()
+ * @see org.apache.catalina.tribes.ChannelSender#start()
*/
public void start() throws java.io.IOException {
getTransport().connect();
@@ -102,9 +102,8 @@ public class ReplicationTransmitter impl
/**
* Call transmitter to check for sender socket status
*
- * @see SimpleTcpCluster#backgroundProcess()
+ * @see org.apache.catalina.ha.tcp.SimpleTcpCluster#backgroundProcess()
*/
-
public void heartbeat() {
if (getTransport()!=null) getTransport().keepalive();
}
@@ -113,7 +112,7 @@ public class ReplicationTransmitter impl
* add new cluster member and create sender ( s. replicationMode) transfer
* current properties to sender
*
- * @see org.apache.catalina.tribes.ClusterSender#add(org.apache.catalina.tribes.Member)
+ * @see org.apache.catalina.tribes.ChannelSender#add(Member)
*/
public synchronized void add(Member member) {
getTransport().add(member);
@@ -122,7 +121,7 @@ public class ReplicationTransmitter impl
/**
* remove sender from transmitter. ( deregister mbean and disconnect sender )
*
- * @see org.apache.catalina.tribes.ClusterSender#remove(org.apache.catalina.tribes.Member)
+ * @see org.apache.catalina.tribes.ChannelSender#remove(Member)
*/
public synchronized void remove(Member member) {
getTransport().remove(member);
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReceiver.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReceiver.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReceiver.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReceiver.java Mon Jan 27 18:37:12 2014
@@ -41,11 +41,7 @@ public class BioReceiver extends Receive
public BioReceiver() {
}
- /**
- *
- * @throws IOException
- * @todo Implement this org.apache.catalina.tribes.ChannelReceiver method
- */
+
public void start() throws IOException {
super.start();
try {
@@ -79,10 +75,7 @@ public class BioReceiver extends Receive
return result;
}
- /**
- *
- * @todo Implement this org.apache.catalina.tribes.ChannelReceiver method
- */
+
public void stop() {
setListen(false);
try {
@@ -90,8 +83,6 @@ public class BioReceiver extends Receive
}catch ( Exception x ) {}
super.stop();
}
-
-
protected void bind() throws IOException {
@@ -103,7 +94,6 @@ public class BioReceiver extends Receive
}
-
public void run() {
try {
listen();
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java Mon Jan 27 18:37:12 2014
@@ -139,8 +139,6 @@ public class BioReplicationTask extends
/**
* send a reply-acknowledgement (6,2,3)
- * @param key
- * @param channel
*/
protected void sendAck(byte[] command) {
try {
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java Mon Jan 27 18:37:12 2014
@@ -89,7 +89,7 @@ public class BioSender extends AbstractS
/**
* Connect other cluster member receiver
- * @see org.apache.catalina.tribes.transport.IDataSender#connect()
+ * @see org.apache.catalina.tribes.transport.DataSender#connect()
*/
public void connect() throws IOException {
openSocket();
@@ -99,7 +99,7 @@ public class BioSender extends AbstractS
/**
* disconnect and close socket
*
- * @see IDataSender#disconnect()
+ * @see DataSender#disconnect()
*/
public void disconnect() {
boolean connect = isConnected();
@@ -113,9 +113,6 @@ public class BioSender extends AbstractS
/**
* Send message
- *
- * @see org.apache.catalina.tribes.transport.IDataSender#sendMessage(,
- * ChannelMessage)
*/
public void sendMessage(byte[] data, boolean waitForAck) throws IOException {
IOException exception = null;
@@ -197,7 +194,6 @@ public class BioSender extends AbstractS
* close socket
*
* @see DataSender#disconnect()
- * @see DataSender#closeSocket()
*/
protected void closeSocket() {
if(isConnected()) {
@@ -223,13 +219,12 @@ public class BioSender extends AbstractS
* Wait for ack is needed and make auto retry when write message is failed.
* After sending error close and reopen socket again.
*
- * After successfull sending update stats
+ * After successful sending update statistics
*
- * WARNING: Subclasses must be very carefull that only one thread call this pushMessage at once!!!
+ * WARNING: Subclasses must be very careful that only one thread call this pushMessage at once!!!
*
* @see #closeSocket()
* @see #openSocket()
- * @see #writeData(ChannelMessage)
*
* @param data
* data to send
@@ -249,8 +244,7 @@ public class BioSender extends AbstractS
/**
* Wait for Acknowledgement from other server
- * FIXME Please, not wait only for three charcters, better control that the wait ack message is correct.
- * @param timeout
+ * FIXME Please, not wait only for three characters, better control that the wait ack message is correct.
* @throws java.io.IOException
* @throws java.net.SocketTimeoutException
*/
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/PooledMultiSender.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/PooledMultiSender.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/PooledMultiSender.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/PooledMultiSender.java Mon Jan 27 18:37:12 2014
@@ -23,16 +23,6 @@ import org.apache.catalina.tribes.Channe
import org.apache.catalina.tribes.transport.MultiPointSender;
import org.apache.catalina.tribes.ChannelMessage;
-/**
- * <p>Title: </p>
- *
- * <p>Description: </p>
- *
- * <p>Company: </p>
- *
- * @author not attributable
- * @version 1.0
- */
public class PooledMultiSender extends PooledSender {
@@ -56,17 +46,10 @@ public class PooledMultiSender extends P
}
}
- /**
- * getNewDataSender
- *
- * @return DataSender
- * @todo Implement this org.apache.catalina.tribes.transport.PooledSender
- * method
- */
+
public DataSender getNewDataSender() {
MultipointBioSender sender = new MultipointBioSender();
sender.transferProperties(this,sender);
return sender;
}
-
}
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/FastQueue.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/FastQueue.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/FastQueue.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/FastQueue.java Mon Jan 27 18:37:12 2014
@@ -153,11 +153,7 @@ public class FastQueue {
lock.setRemoveWaitTimeout(removeWaitTimeout);
}
- /**
- * get Max Queue length
- *
- * @see org.apache.catalina.tribes.util.IQueue#getMaxQueueLength()
- */
+
public int getMaxQueueLength() {
return maxQueueLength;
}
@@ -246,7 +242,6 @@ public class FastQueue {
/**
* Add new data to the queue
- * @see org.apache.catalina.tribes.util.IQueue#add(java.lang.String, java.lang.Object)
* FIXME extract some method
*/
public boolean add(ChannelMessage msg, Member[] destination, InterceptorPayload payload) {
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java Mon Jan 27 18:37:12 2014
@@ -46,7 +46,6 @@ public class LinkObject {
* Construct a new element from the data object.
* Sets the pointer to null.
*
- * @param key The key
* @param payload The data object.
*/
public LinkObject(ChannelMessage msg, Member[] destination, InterceptorPayload payload) {
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java Mon Jan 27 18:37:12 2014
@@ -85,8 +85,7 @@ public class NioReceiver extends Receive
/**
* start cluster receiver
- * @throws Exception
- * @see org.apache.catalina.tribes.ClusterReceiver#start()
+ * @see org.apache.catalina.tribes.ChannelReceiver#start()
*/
public void start() throws IOException {
super.start();
@@ -312,7 +311,7 @@ public class NioReceiver extends Receive
/**
* Close Selector.
*
- * @see org.apache.catalina.tribes.transport.ClusterReceiverBase#stopListening()
+ * @see ChannelReceiverBase#stopListening()
*/
protected void stopListening() {
setListen(false);
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java?rev=1561778&r1=1561777&r2=1561778&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java Mon Jan 27 18:37:12 2014
@@ -197,9 +197,6 @@ public class NioSender extends AbstractS
/**
* connect - blocking in this operation
- *
- * @throws IOException
- * @todo Implement this org.apache.catalina.tribes.transport.IDataSender method
*/
public synchronized void connect() throws IOException {
if ( connecting ) return;
@@ -229,11 +226,6 @@ public class NioSender extends AbstractS
}
- /**
- * disconnect
- *
- * @todo Implement this org.apache.catalina.tribes.transport.IDataSender method
- */
public void disconnect() {
try {
connecting = false;
@@ -285,16 +277,10 @@ public class NioSender extends AbstractS
return (getDirectBuffer()?ByteBuffer.allocateDirect(size):ByteBuffer.allocate(size));
}
- /**
- * sendMessage
- *
- * @param data ChannelMessage
- * @throws IOException
- * @todo Implement this org.apache.catalina.tribes.transport.IDataSender method
- */
- public synchronized void setMessage(byte[] data) throws IOException {
- setMessage(data,0,data.length);
- }
+
+ public synchronized void setMessage(byte[] data) throws IOException {
+ setMessage(data,0,data.length);
+ }
public synchronized void setMessage(byte[] data,int offset, int length) throws IOException {
if ( data != null ) {
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org