You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ta...@apache.org on 2009/06/13 01:25:49 UTC

svn commit: r784312 - in /activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories: AdvisoryConsumer.h AdvisoryProducer.h

Author: tabish
Date: Fri Jun 12 23:25:49 2009
New Revision: 784312

URL: http://svn.apache.org/viewvc?rev=784312&view=rev
Log:
Add descriptions to each example class.

Modified:
    activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryConsumer.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryProducer.h

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryConsumer.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryConsumer.h?rev=784312&r1=784311&r2=784312&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryConsumer.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryConsumer.h Fri Jun 12 23:25:49 2009
@@ -30,6 +30,15 @@
 namespace examples {
 namespace advisories {
 
+    /**
+     * A simple Consumer that compliements the AdvisoryProducer example.  This
+     * consumer listens on the Topic that the Producer is waiting to publish on
+     * and will display the count of Producers that are active on the Topic
+     * any time that it sees an advisory message indicating a consumer has
+     * stopped or started.
+     *
+     * @since 3.0
+     */
     class AdvisoryConsumer : public cms::Closeable,
                              public cms::MessageListener {
      private:

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryProducer.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryProducer.h?rev=784312&r1=784311&r2=784312&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryProducer.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/examples/advisories/AdvisoryProducer.h Fri Jun 12 23:25:49 2009
@@ -33,6 +33,14 @@
 namespace examples {
 namespace advisories {
 
+    /**
+     * A sample Producer that will only send Messages on its Topic when it has
+     * received an advisory indicating that there is an active MessageConsumer
+     * on the Topic.  Once another message comes in indicating that there is no
+     * longer a consumer then this Producer stops producing again.
+     *
+     * @since 3.0
+     */
     class AdvisoryProducer : public decaf::lang::Runnable,
                              public cms::MessageListener {
     private: