ignite-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [ignite] Mmuzaf commented on a change in pull request #6760: IGNITE-12051: update javadoc for IgniteKernal class
Date Mon, 12 Aug 2019 15:51:53 GMT
Mmuzaf commented on a change in pull request #6760: IGNITE-12051: update javadoc for IgniteKernal
class
URL: https://github.com/apache/ignite/pull/6760#discussion_r312996934
 
 

 ##########
 File path: modules/core/src/main/java/org/apache/ignite/internal/IgniteKernal.java
 ##########
 @@ -293,52 +294,79 @@
 import static org.apache.ignite.lifecycle.LifecycleEventType.BEFORE_NODE_START;
 
 /**
- * Ignite kernal.
- * <p/>
- * See <a href="http://en.wikipedia.org/wiki/Kernal">http://en.wikipedia.org/wiki/Kernal</a>
for information on the
- * misspelling.
+ * This class represents an implementation of the extended main Ignite API (called {@link
IgniteEx}). It also controls
+ * the Ignite life cycle and allows listening for Ignite events.
+ * <p>
+ * Please, refer to the wiki <a href="http://en.wikipedia.org/wiki/Kernal">http://en.wikipedia.org/wiki/Kernal</a>
+ * for the information on the misspelling.
+ * <p>
+ * <h3>Start point</h3>
+ * The main entry point for all the Ignite instances creation is the <tt>org.apache.ignite.internal.IgniteKernal#start()</tt>
+ * method. It starts internal Ignites components (see {@link GridComponent}), for instance:
+ * <ul>
+ * <li>{@link GridManager} - a layer of indirection between kernal and SPI modules.</li>
+ * <li>{@link GridProcessor} - an objects responsible for particular internal process
implementation.</li>
+ * <li>{@link IgnitePlugin} - an Ignite addition of user-provided functionality.</li>
+ * </ul>
+ * The <tt>start()</tt> method also perfoms additional validation of the provided
{@link IgniteConfiguration} and
+ * prints some suggestions such as:
+ * <ul>
+ * <li>Ignites configuration optimizations (e.g. disabling {@link EventType} events).</li>
+ * <li>{@link JvmConfigurationSuggestions} optimizations</li>
+ * <li>{@link OsConfigurationSuggestions} optimizations</li>
+ * </ul>
  */
 public class IgniteKernal implements IgniteEx, IgniteMXBean, Externalizable {
-    /** */
+    /** Class serialization version number. */
     private static final long serialVersionUID = 0L;
 
-    /** Ignite site that is shown in log messages. */
+    /** Ignite web-site that is shown in log messages. */
     public static final String SITE = "ignite.apache.org";
 
     /** System line separator. */
     private static final String NL = U.nl();
 
-    /** Periodic starvation check interval. */
+    /**
+     * Default interval of checking thread pool state for the starvation. Will be used only
if the
+     * {@link IgniteSystemProperties#IGNITE_STARVATION_CHECK_INTERVAL} system property is
not set.
+     * <p>
+     * Value is {@code 30 sec}.
+     */
     private static final long PERIODIC_STARVATION_CHECK_FREQ = 1000 * 30;
 
-    /** Force complete reconnect future. */
+    /** Object is used to force completion the previous reconnection attempt. See {@link
ReconnectState} for details. */
     private static final Object STOP_RECONNECT = new Object();
 
-    /** Separator for formatted coordinator properties. */
+    /** The separator is used for coordinator properties formatted as a string. */
     public static final String COORDINATOR_PROPERTIES_SEPARATOR = ",";
 
-    /** Default long operations dump timeout. */
+    /**
+     * Default timeout in milliseconds for dumping long running operations. Will be used
if the
+     * {@link IgniteSystemProperties#IGNITE_LONG_OPERATIONS_DUMP_TIMEOUT} is not set.
+     * <p>
+     * Value is {@code 60 sec}.
+     */
     public static final long DFLT_LONG_OPERATIONS_DUMP_TIMEOUT = 60_000L;
 
-    /** Long jvm pause detector. */
+    /** Currently used instance of JVM pause detector thread. See {@link LongJVMPauseDetector}
for details. */
     private LongJVMPauseDetector longJVMPauseDetector;
 
-    /** */
+    /** The main kernal context which holds all the {@link GridComponent}s. */
     @GridToStringExclude
     private GridKernalContextImpl ctx;
 
-    /** Helper that registers MBeans */
+    /** Helper which is register and unregister MBeans. */
 
 Review comment:
   Fixed.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message