korlov42 commented on code in PR #4615: URL: https://github.com/apache/ignite-3/pull/4615#discussion_r1822046900
########## modules/api/src/main/java/org/apache/ignite/lang/CancelHandleImpl.java: ########## @@ -0,0 +1,162 @@ +/* + * 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.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +/** Implementation of {@link CancelHandle}. */ +public final class CancelHandleImpl implements CancelHandle { + + private final ConcurrentLinkedQueue<CancellationTokenImpl> tokens = new ConcurrentLinkedQueue<>(); + + private final AtomicBoolean cancelled = new AtomicBoolean(); + + /** {@inheritDoc} */ + @Override + public void cancel() { + if (!cancelled.compareAndSet(false, true)) { + return; + } + doCancelSync(); + } + + /** {@inheritDoc} */ + @Override + public CompletableFuture<Void> cancelAsync() { + if (!cancelled.compareAndSet(false, true)) { + return CompletableFuture.completedFuture(null); Review Comment: such implementation violates the contract. Second call to `cancel` will return completed future, while resource still may be held ########## modules/api/src/main/java/org/apache/ignite/lang/CancelHandleImpl.java: ########## @@ -0,0 +1,162 @@ +/* + * 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.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +/** Implementation of {@link CancelHandle}. */ +public final class CancelHandleImpl implements CancelHandle { + + private final ConcurrentLinkedQueue<CancellationTokenImpl> tokens = new ConcurrentLinkedQueue<>(); Review Comment: why do we need multiple tokens for the same handle? ########## modules/api/src/main/java/org/apache/ignite/lang/CancelHandleImpl.java: ########## @@ -0,0 +1,162 @@ +/* + * 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.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +/** Implementation of {@link CancelHandle}. */ +public final class CancelHandleImpl implements CancelHandle { Review Comment: `CancelHandleImpl` must be package-private. It's not supposed to be used directly by user, and we don't want to treat this like part of the public API. ########## modules/core/src/main/java/org/apache/ignite/internal/util/Cancellable.java: ########## @@ -27,4 +29,9 @@ public interface Cancellable { * @param timeout If process was cancelled due to timeout. */ void cancel(boolean timeout); + + /** + * Returns a future that completes when a cancellation produce, triggered by {@link Cancellable#cancel(boolean)} completes. + */ + CompletableFuture<Void> future(); Review Comment: looks like this future should be returned from `cancel` method ########## modules/api/src/main/java/org/apache/ignite/lang/CancelHandleImpl.java: ########## @@ -0,0 +1,162 @@ +/* + * 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.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +/** Implementation of {@link CancelHandle}. */ +public final class CancelHandleImpl implements CancelHandle { + + private final ConcurrentLinkedQueue<CancellationTokenImpl> tokens = new ConcurrentLinkedQueue<>(); + + private final AtomicBoolean cancelled = new AtomicBoolean(); + + /** {@inheritDoc} */ + @Override + public void cancel() { Review Comment: do we really need distinct implementation for synchronous cancellation? Common pattern is to join on future returned from async counterpart (see `org.apache.ignite.internal.sql.SyncResultSetAdapter#close` of example) ########## modules/api/src/main/java/org/apache/ignite/lang/CancellationToken.java: ########## @@ -0,0 +1,22 @@ +/* + * 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. */ Review Comment: what user is supposed to do with this thing? let's improve javadoc to make it clear -- 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
