From 24526f2b9d9ddb95c6f865b56c8c3e943195c87f Mon Sep 17 00:00:00 2001
From: pengys5 <8082209@qq.com>
Date: Wed, 12 Apr 2017 22:07:30 +0800
Subject: [PATCH] fix comments
---
.../actor/AbstractClusterWorker.java | 19 +++++++++----------
.../actor/AbstractClusterWorkerProvider.java | 6 +++---
.../actor/AbstractLocalAsyncWorker.java | 8 ++++----
.../actor/selector/AbstractHashMessage.java | 9 ++++-----
.../actor/selector/HashCodeSelector.java | 2 +-
.../actor/selector/RollingSelector.java | 2 +-
.../actor/selector/WorkerSelector.java | 2 +-
7 files changed, 23 insertions(+), 25 deletions(-)
diff --git a/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/AbstractClusterWorker.java b/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/AbstractClusterWorker.java
index 249a152d06..4adff6da6a 100644
--- a/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/AbstractClusterWorker.java
+++ b/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/AbstractClusterWorker.java
@@ -11,22 +11,21 @@ import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
/**
- * The AbstractClusterWorker
should be implemented by any class whose instances
- * are intended to provide receive remote message that message will transfer across different jvm
- * which running in same server or another address server.
+ * The AbstractClusterWorker
implementations represent workers,
+ * which receive remote messages.
*
- * Usually the implemented class used to receive persistence data or aggregation the metric.
+ * Usually, the implementations are doing persistent, or aggregate works.
*
* @author pengys5
- * @since feature3.0
+ * @since v3.0-2017
*/
public abstract class AbstractClusterWorker extends AbstractWorker {
/**
- * Constructs a AbstractClusterWorker
with the worker role and context.
+ * Construct an AbstractClusterWorker
with the worker role and context.
*
- * @param role The responsibility of worker in cluster, more than one workers can have
- * same responsibility which use to provide load balancing ability.
+ * @param role If multi-workers are for load balance, they should be more likely called worker instance.
+ * Meaning, each worker have multi instances.
* @param clusterContext See {@link ClusterWorkerContext}
* @param selfContext See {@link LocalWorkerContext}
*/
@@ -35,7 +34,7 @@ public abstract class AbstractClusterWorker extends AbstractWorker {
}
/**
- * Receive message
+ * This method use for message producer to call for send message.
*
* @param message The persistence data or metric data.
* @throws Exception The Exception happen in {@link #onWork(Object)}
@@ -45,7 +44,7 @@ public abstract class AbstractClusterWorker extends AbstractWorker {
}
/**
- * The data process logic in this method.
+ * This method use for message receiver to analyse message.
*
* @param message Cast the message object to a expect subclass.
* @throws Exception Don't handle the exception, throw it.
diff --git a/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/AbstractClusterWorkerProvider.java b/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/AbstractClusterWorkerProvider.java
index 1820e5e6df..6b7bb5ef50 100644
--- a/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/AbstractClusterWorkerProvider.java
+++ b/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/AbstractClusterWorkerProvider.java
@@ -4,12 +4,12 @@ import akka.actor.ActorRef;
import akka.actor.Props;
/**
- * The AbstractClusterWorkerProvider
should be implemented by any class whose instances
- * are intended to provide create the class instance whose implemented {@link AbstractClusterWorker}.
+ * The AbstractClusterWorkerProvider
implementations represent providers,
+ * which create instance of cluster workers whose implemented {@link AbstractClusterWorker}.
*
*
* @author pengys5
- * @since feature3.0
+ * @since v3.0-2017
*/
public abstract class AbstractClusterWorkerProvider
- * Usually the implemented class used to persistence data to database
- * or aggregation the metric.
*
* @author pengys5
- * @since feature3.0
+ * @since v3.0-2017
*/
public abstract class AbstractHashMessage {
private int hashCode;
diff --git a/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/selector/HashCodeSelector.java b/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/selector/HashCodeSelector.java
index 6e8b52c8a5..62a21026df 100644
--- a/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/selector/HashCodeSelector.java
+++ b/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/selector/HashCodeSelector.java
@@ -11,7 +11,7 @@ import java.util.List;
* message to same {@link WorkerRef}. Usually, use to database operate which avoid dirty data.
*
* @author pengys5
- * @since feature3.0
+ * @since v3.0-2017
*/
public class HashCodeSelector implements WorkerSelectorAbstractLocalAsyncWorker
should be implemented by any class whose instances
- * are intended to provide receive asynchronous message in same jvm.
+ * The AbstractLocalAsyncWorker
implementations represent workers,
+ * which receive local asynchronous message.
*
* @author pengys5
- * @since feature3.0
+ * @since v3.0-2017
*/
public abstract class AbstractLocalAsyncWorker extends AbstractLocalWorker {
/**
- * Constructs a AbstractLocalAsyncWorker
with the worker role and context.
+ * Construct an AbstractLocalAsyncWorker
with the worker role and context.
*
* @param role The responsibility of worker in cluster, more than one workers can have
* same responsibility which use to provide load balancing ability.
diff --git a/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/selector/AbstractHashMessage.java b/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/selector/AbstractHashMessage.java
index a5fb46af4a..df1449b5d0 100644
--- a/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/selector/AbstractHashMessage.java
+++ b/skywalking-collector/skywalking-collector-cluster/src/main/java/com/a/eye/skywalking/collector/actor/selector/AbstractHashMessage.java
@@ -1,14 +1,13 @@
package com.a.eye.skywalking.collector.actor.selector;
/**
- * The AbstractHashMessage
should be implemented by any class whose instances
- * are intended to provide send message with {@link HashCodeSelector}.
+ * The AbstractHashMessage
implementations represent aggregate message,
+ * which use to aggregate metric.
+ * Make the message aggregator's worker selector use of {@link HashCodeSelector}.
* WorkerRef
is designed to provide a routing ability in the collector cluster
*
* @author pengys5
- * @since feature3.0
+ * @since v3.0-2017
*/
public interface WorkerSelector