ignite-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [ignite] pavlukhin commented on a change in pull request #6760: IGNITE-12051: update javadoc for IgniteKernal class
Date Tue, 13 Aug 2019 06:45:26 GMT
pavlukhin commented on a change in pull request #6760: IGNITE-12051: update javadoc for IgniteKernal
class
URL: https://github.com/apache/ignite/pull/6760#discussion_r313238099
 
 

 ##########
 File path: modules/core/src/main/java/org/apache/ignite/internal/IgniteKernal.java
 ##########
 @@ -293,52 +296,95 @@
 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 main Ignite API {@link Ignite} which is
expanded by additional
+ * methods of {@link IgniteEx} for the internal Ignite needs. It also controls the Ignite
life cycle, checks
+ * thread pools state for starvation, detects long JVM pauses and prints out the local node
metrics.
+ *
+ * <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>Startpoint</h3>
+ * The main entry point for all the Ignite instances creation is the method:
+ * <p>
+ * {@link #start(IgniteConfiguration, ExecutorService, ExecutorService, ExecutorService,
ExecutorService,StripedExecutor, ExecutorService, ExecutorService, ExecutorService, StripedExecutor,
ExecutorService, ExecutorService, ExecutorService, IgniteStripedThreadPoolExecutor, ExecutorService,
ExecutorService, Map, GridAbsClosure, WorkersRegistry, Thread.UncaughtExceptionHandler, TimeBag)}
+ * <p>
+ * 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 {@code start} 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>
+ *
+ * <h3>Endpoint</h3>
 
 Review comment:
   _Endpoint_ often means some kind of an exposed interface (e.g. listening connection/port)
but not shutdown/termination. I suggest to use _Stopping_ here. And _Starting_ instead of
_Startpoint_ for a symmetry.

----------------------------------------------------------------
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