Changeset 4161

Timestamp:

2010-07-20 09:23:08 (3 years ago)

Author:

evert

Message:

Updated some javadoc on registering and unregistering RowLogMessageConsumers? on the RowLogProcessor?.

Location:

trunk/rowlog/api/src/main/java/org/lilycms/rowlog/api

Files:

• RowLog.java (modified) (1 diff)
• RowLogProcessor.java (modified) (1 diff)

trunk/rowlog/api/src/main/java/org/lilycms/rowlog/api/RowLog.java

@@ -167 +167 @@
     List<RowLogMessageConsumer> getConsumers();
 
+    /**
+     * This method allows a {@link RowLogProcessor} to be set on the {@link RowLog}.
+     * The RowLog can then inform the RowLogProcessor when a {@link RowLogMessageConsumer} is registered or unregistered.
+     * This will have to be changed once the Lily distributed node behaviour is implemented. See issue #52. 
+     * @param rowLogProcessor
+     */
     void setProcessor(RowLogProcessor rowLogProcessor);
 }

trunk/rowlog/api/src/main/java/org/lilycms/rowlog/api/RowLogProcessor.java

@@ -40 +40 @@
     boolean isRunning(int consumerId);
 
+    /**
+     * Notifies the processor that a new {@link RowLogMessageConsumer} has been registered.
+     * The processor will start processing messages for this consumer.
+     */
     void consumerRegistered(RowLogMessageConsumer consumer);
 
+    /**
+     * Notifies the processor that a {@link RowLogMessageConsumer} has been unregistered.
+     * The processor will stop processing messages for this consumer.
+     */
     void consumerUnregistered(RowLogMessageConsumer consumer);
 }