Skip to content

Commit fc934a4

Browse files
committed
IGNITE-26608 Add JavaDocs and change pools package.
1 parent 5df3c84 commit fc934a4

7 files changed

Lines changed: 23 additions & 12 deletions

File tree

modules/commons/src/main/java/org/apache/ignite/internal/thread/context/Context.java

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@
1919

2020
import java.util.ArrayList;
2121
import java.util.List;
22+
import org.apache.ignite.internal.thread.context.concurrent.ContextAwareExecutor;
2223
import org.apache.ignite.internal.util.typedef.F;
2324
import org.jetbrains.annotations.Nullable;
2425

2526
import static org.apache.ignite.internal.thread.context.Scope.NOOP_SCOPE;
2627

2728
/**
28-
* Represents a storage of {@link ContextAttribute}s and their corresponding values bound to the thread.
29+
* Represents a storage of {@link ContextAttribute}s and their corresponding values bound to the JVM thread.
2930
* The state of Context is determined by a sequence of {@link Update}s applied to it. Each Update stores the
3031
* updated or newly added {@link ContextAttribute} values and link to the previous Update.
3132
* <pre>
@@ -37,6 +38,16 @@
3738
*</pre>
3839
* Context Updates can be undone in the same order they were applied by closing the {@link Scope} associated with each
3940
* update (see {@link #set(ContextAttribute, Object)} and related methods).
41+
*<p>
42+
* Context bound to one JVM thread can be saved and restored in another thread using the snapshot mechanism
43+
* (see {@link #createSnapshot()} and {@link #restoreSnapshot(ContextSnapshot) methods}). This provides basic
44+
* functionality for implementing asynchronous executors that automatically propagate Context data between JVM threads.
45+
*</p>
46+
*
47+
* @see Scope
48+
* @see ContextSnapshot
49+
* @see ContextAwareWrapper
50+
* @see ContextAwareExecutor
4051
*/
4152
public class Context {
4253
/** */

modules/core/src/main/java/org/apache/ignite/internal/processors/pool/PoolProcessor.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@
4545
import org.apache.ignite.internal.processors.security.IgniteSecurity;
4646
import org.apache.ignite.internal.processors.timeout.GridTimeoutProcessor;
4747
import org.apache.ignite.internal.systemview.StripedExecutorTaskViewWalker;
48-
import org.apache.ignite.internal.thread.context.pool.ContextAwareIoPool;
49-
import org.apache.ignite.internal.thread.context.pool.ContextAwareStripedExecutor;
50-
import org.apache.ignite.internal.thread.context.pool.ContextAwareStripedThreadPoolExecutor;
51-
import org.apache.ignite.internal.thread.context.pool.ContextAwareThreadPoolExecutor;
48+
import org.apache.ignite.internal.thread.pool.ContextAwareIoPool;
49+
import org.apache.ignite.internal.thread.pool.ContextAwareStripedExecutor;
50+
import org.apache.ignite.internal.thread.pool.ContextAwareStripedThreadPoolExecutor;
51+
import org.apache.ignite.internal.thread.pool.ContextAwareThreadPoolExecutor;
5252
import org.apache.ignite.internal.util.StripedExecutor;
5353
import org.apache.ignite.internal.util.tostring.GridToStringExclude;
5454
import org.apache.ignite.internal.util.typedef.F;

modules/core/src/main/java/org/apache/ignite/internal/thread/context/pool/ContextAwareIoPool.java renamed to modules/core/src/main/java/org/apache/ignite/internal/thread/pool/ContextAwareIoPool.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18-
package org.apache.ignite.internal.thread.context.pool;
18+
package org.apache.ignite.internal.thread.pool;
1919

2020
import java.util.concurrent.Executor;
2121
import org.apache.ignite.internal.thread.context.concurrent.ContextAwareExecutor;

modules/core/src/main/java/org/apache/ignite/internal/thread/context/pool/ContextAwareStripedExecutor.java renamed to modules/core/src/main/java/org/apache/ignite/internal/thread/pool/ContextAwareStripedExecutor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18-
package org.apache.ignite.internal.thread.context.pool;
18+
package org.apache.ignite.internal.thread.pool;
1919

2020
import org.apache.ignite.IgniteLogger;
2121
import org.apache.ignite.internal.thread.context.function.ContextAwareRunnable;

modules/core/src/main/java/org/apache/ignite/internal/thread/context/pool/ContextAwareStripedThreadPoolExecutor.java renamed to modules/core/src/main/java/org/apache/ignite/internal/thread/pool/ContextAwareStripedThreadPoolExecutor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18-
package org.apache.ignite.internal.thread.context.pool;
18+
package org.apache.ignite.internal.thread.pool;
1919

2020
import org.apache.ignite.internal.thread.context.function.ContextAwareRunnable;
2121
import org.apache.ignite.thread.IgniteStripedThreadPoolExecutor;

modules/core/src/main/java/org/apache/ignite/internal/thread/context/pool/ContextAwareThreadPoolExecutor.java renamed to modules/core/src/main/java/org/apache/ignite/internal/thread/pool/ContextAwareThreadPoolExecutor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18-
package org.apache.ignite.internal.thread.context.pool;
18+
package org.apache.ignite.internal.thread.pool;
1919

2020
import java.util.Collection;
2121
import java.util.List;

modules/core/src/test/java/org/apache/ignite/internal/thread/context/ContextAttributesTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
import java.util.concurrent.ExecutorService;
2727
import java.util.concurrent.LinkedBlockingQueue;
2828
import org.apache.ignite.internal.managers.communication.GridIoPolicy;
29-
import org.apache.ignite.internal.thread.context.pool.ContextAwareStripedExecutor;
30-
import org.apache.ignite.internal.thread.context.pool.ContextAwareStripedThreadPoolExecutor;
31-
import org.apache.ignite.internal.thread.context.pool.ContextAwareThreadPoolExecutor;
29+
import org.apache.ignite.internal.thread.pool.ContextAwareStripedExecutor;
30+
import org.apache.ignite.internal.thread.pool.ContextAwareStripedThreadPoolExecutor;
31+
import org.apache.ignite.internal.thread.pool.ContextAwareThreadPoolExecutor;
3232
import org.apache.ignite.testframework.junits.common.GridCommonAbstractTest;
3333
import org.junit.Test;
3434

0 commit comments

Comments
 (0)