From notifications-return-5951-archive-asf-public=cust-asf.ponee.io@ignite.apache.org Mon Aug 12 15:28:35 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id D4E95180637 for ; Mon, 12 Aug 2019 17:28:34 +0200 (CEST) Received: (qmail 32044 invoked by uid 500); 12 Aug 2019 15:28:34 -0000 Mailing-List: contact notifications-help@ignite.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@ignite.apache.org Delivered-To: mailing list notifications@ignite.apache.org Received: (qmail 32035 invoked by uid 99); 12 Aug 2019 15:28:33 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 12 Aug 2019 15:28:33 +0000 From: GitBox To: notifications@ignite.apache.org Subject: [GitHub] [ignite] Mmuzaf commented on a change in pull request #6760: IGNITE-12051: update javadoc for IgniteKernal class Message-ID: <156562371381.25972.3624766562354550067.gitbox@gitbox.apache.org> Date: Mon, 12 Aug 2019 15:28:33 -0000 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit 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_r312984958 ########## 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. - *

- * See http://en.wikipedia.org/wiki/Kernal 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. + *

+ * Please, refer to the wiki http://en.wikipedia.org/wiki/Kernal + * for the information on the misspelling. + *

+ *

Start point

+ * The main entry point for all the Ignite instances creation is the org.apache.ignite.internal.IgniteKernal#start() + * method. It starts internal Ignites components (see {@link GridComponent}), for instance: + *
    + *
  • {@link GridManager} - a layer of indirection between kernal and SPI modules.
    • + *
  • {@link GridProcessor} - an objects responsible for particular internal process implementation.
    • + *
  • {@link IgnitePlugin} - an Ignite addition of user-provided functionality.
    • + *
+ * The start() method also perfoms additional validation of the provided {@link IgniteConfiguration} and + * prints some suggestions such as: + *
    + *
  • Ignites configuration optimizations (e.g. disabling {@link EventType} events).
    • + *
  • {@link JvmConfigurationSuggestions} optimizations
    • + *
  • {@link OsConfigurationSuggestions} optimizations
    • + *
*/ 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. + *

+ * 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. + *

+ * 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. */ @GridToStringExclude private IgniteMBeansManager mBeansMgr; - /** Configuration. */ + /** Ignite runtime configuration instance. */ Review comment: Agree, I've fixed it. ---------------------------------------------------------------- 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