lowka commented on code in PR #4615: URL: https://github.com/apache/ignite-3/pull/4615#discussion_r1834339446
########## modules/core/src/main/java/org/apache/ignite/lang/CancelHandleHelper.java: ########## @@ -0,0 +1,83 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.lang; + +import java.util.Objects; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.lang.CancelHandleImpl.CancellationTokenImpl; + +/** + * Utility class to provide direct access to internals of {@link CancelHandleImpl}. + */ +public final class CancelHandleHelper { + + private CancelHandleHelper() { + + } + + /** + * Attaches a cancellable operation to the given token. A cancellation procedure started its handle completes + * when {@code completionFut} completes. + * + * <p>NOTE: If a handle, this token is associated with, was cancelled or its cancellation was requested, + * this method immediately invokes {@code cancelAction.run()} and it this case + * <b>it never waits for {@code completionFut} to complete</b>. + * + * <p>The following methods request cancellation of a handle: + * <ul> + * <li>{@link CancelHandle#cancel()}</li> + * <li>{@link CancelHandle#cancelAsync()}</li> + * </ul> + * + * @param token Cancellation token. + * @param cancelAction Action that terminates an operation. + * @param completionFut Future that completes when operation completes and all resources it created are released. + */ + public static void addCancelAction( + CancellationToken token, + Runnable cancelAction, + CompletableFuture<?> completionFut + ) { + Objects.requireNonNull(token, "token"); + Objects.requireNonNull(cancelAction, "cancelAction"); + Objects.requireNonNull(completionFut, "completionFut"); + + CancellationTokenImpl t = unwrapToken(token); + t.addCancelAction(cancelAction, completionFut); + } + + /** + * Returns a future associated with this cancellation token's handle. + * + * @param token Cancellation token. + */ + public static CompletableFuture<Void> getCancellationFuture(CancellationToken token) { Review Comment: Fixed. ########## modules/api/src/main/java/org/apache/ignite/lang/CancellationToken.java: ########## @@ -0,0 +1,25 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.ignite.lang; + +/** + * Cancellation token an object is issued by {@link CancelHandle} that can be used by an operation or a resource to observe a signal + * to terminate it. + */ 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. To unsubscribe, e-mail: notifications-unsubscr...@ignite.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
