From 60bb46798e41bac8c13a53e1f47c5ea46d2fc78e Mon Sep 17 00:00:00 2001
From: Robert Greig <rgreig@apache.org>
Date: Thu, 25 Jan 2007 12:13:44 +0000
Subject: (Submitted by Rupert Smith) Class has been documented.

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@499757 13f79535-47bb-0310-9956-ffa450edef68
---
 .../main/java/org/apache/qpid/ping/AbstractPingClient.java  | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

(limited to 'java/perftests')

diff --git a/java/perftests/src/main/java/org/apache/qpid/ping/AbstractPingClient.java b/java/perftests/src/main/java/org/apache/qpid/ping/AbstractPingClient.java
index c16213a92e..c1dd5b18ad 100644
--- a/java/perftests/src/main/java/org/apache/qpid/ping/AbstractPingClient.java
+++ b/java/perftests/src/main/java/org/apache/qpid/ping/AbstractPingClient.java
@@ -31,11 +31,11 @@ import org.apache.qpid.client.AMQConnection;
 import org.apache.qpid.jms.Session;
 
 /**
- * Provides common functionality that ping clients can use. This base class keeps track of the connection used to send
- * pings, provides a convenience method to commit a transaction only when a session to commit on is transactional, keeps
- * track of whether the ping client is pinging to a queue or a topic, provides prompts to the console to terminate brokers
- * before and after commits, in order to test failover functionality, and provides a convience formatter for outputing
- * readable timestamps for pings.
+ * Provides common functionality that ping clients (the recipients of ping messages) can use. This base class keeps
+ * track of the connection used to send pings, provides a convenience method to commit a transaction only when a session
+ * to commit on is transactional, keeps track of whether the ping client is pinging to a queue or a topic, provides
+ * prompts to the console to terminate brokers before and after commits, in order to test failover functionality, and
+ * provides a convience formatter for outputing readable timestamps for pings.
  *
  * <p><table id="crc"><caption>CRC Card</caption>
  * <tr><th> Responsibilities <th> Collaborations
@@ -44,6 +44,9 @@ import org.apache.qpid.jms.Session;
  * <tr><td> Keep track the connection.
  * <tr><td> Keep track of p2p or topic ping type.
  * </table>
+ *
+ * @todo This base class does not seem particularly usefull and some methods are duplicated in {@link AbstractPingProducer},
+ *       consider merging it into that class.
  */
 public abstract class AbstractPingClient
 {
-- 
cgit v1.2.1