You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rp...@apache.org on 2015/09/20 10:25:24 UTC

[06/12] logging-log4j2 git commit: LOG4J2-1121 javadoc, comments

LOG4J2-1121 javadoc, comments

Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/5f95edfe
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/5f95edfe
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/5f95edfe

Branch: refs/heads/master
Commit: 5f95edfe7f80b5759061faecf990f0e0acd8a424
Parents: 7bc0ad1
Author: rpopma <rp...@apache.org>
Authored: Sun Sep 20 05:52:48 2015 +0900
Committer: rpopma <rp...@apache.org>
Committed: Sun Sep 20 05:52:48 2015 +0900

----------------------------------------------------------------------
 .../log4j/core/config/AwaitCompletionReliabilityStrategy.java  | 6 +++---
 .../logging/log4j/core/config/DefaultReliabilityStrategy.java  | 2 +-
 .../apache/logging/log4j/core/config/ReliabilityStrategy.java  | 6 +++++-
 3 files changed, 9 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/5f95edfe/log4j-core/src/main/java/org/apache/logging/log4j/core/config/AwaitCompletionReliabilityStrategy.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/AwaitCompletionReliabilityStrategy.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/AwaitCompletionReliabilityStrategy.java
index fc75031..90a1108 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/AwaitCompletionReliabilityStrategy.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/AwaitCompletionReliabilityStrategy.java
@@ -31,8 +31,8 @@ import org.apache.logging.log4j.message.Message;
 import org.apache.logging.log4j.util.Supplier;
 
 /**
- * Object responsible for ensuring log events are delivered to a working appender, even during or after a
- * reconfiguration.
+ * ReliabilityStrategy that counts the number of threads that have started to log an event but have not completed yet,
+ * and waits for these threads to finish before allowing the appenders to be stopped.
  */
 public class AwaitCompletionReliabilityStrategy implements ReliabilityStrategy {
     private static final int MAX_RETRIES = 3;
@@ -123,7 +123,7 @@ public class AwaitCompletionReliabilityStrategy implements ReliabilityStrategy {
         try {
             if (shutdown.compareAndSet(false, true)) {
                 int retries = 0;
-                // while (counter.get() > 0) {
+                // repeat while counter is non-zero
                 while (!counter.compareAndSet(0, Integer.MIN_VALUE)) {
 
                     // counter was non-zero

http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/5f95edfe/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultReliabilityStrategy.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultReliabilityStrategy.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultReliabilityStrategy.java
index 3ffc127..8387511 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultReliabilityStrategy.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultReliabilityStrategy.java
@@ -26,7 +26,7 @@ import org.apache.logging.log4j.message.Message;
 import org.apache.logging.log4j.util.Supplier;
 
 /**
- * Reliability strategy that does nothing.
+ * Reliability strategy that assumes reconfigurations will never take place.
  */
 public class DefaultReliabilityStrategy implements ReliabilityStrategy {
 

http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/5f95edfe/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ReliabilityStrategy.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ReliabilityStrategy.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ReliabilityStrategy.java
index 76d8704..3c86d9c 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ReliabilityStrategy.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ReliabilityStrategy.java
@@ -56,6 +56,9 @@ public interface ReliabilityStrategy {
      */
     LoggerConfig getActiveLoggerConfig(Supplier<LoggerConfig> next);
 
+    /**
+     * Called after a log event was logged.
+     */
     void afterLogEvent();
     
     /**
@@ -64,8 +67,9 @@ public interface ReliabilityStrategy {
     void beforeStopAppenders();
 
     /**
+     * Called before the configuration is stopped.
      * 
-     * @param abstractConfiguration
+     * @param configuration
      */
     void beforeStopConfiguration(Configuration configuration);