lhotari commented on code in PR #24833: URL: https://github.com/apache/pulsar/pull/24833#discussion_r2426609426
########## pulsar-common/src/main/java/org/apache/pulsar/common/semaphore/AsyncSemaphore.java: ########## @@ -0,0 +1,109 @@ +/* + * 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.pulsar.common.semaphore; + +import java.util.concurrent.CompletableFuture; +import java.util.function.BooleanSupplier; + +/** + * An abstraction for a generic asynchronous semaphore. + */ +public interface AsyncSemaphore { + /** + * Acquire permits from the semaphore. + * Returned future completes when permits are available. + * It will complete exceptionally with AsyncSemaphorePermitAcquireTimeoutException on timeout + * and exceptionally with AsyncSemaphorePermitAcquireQueueFullException when queue full + * @return CompletableFuture that completes with permit when available + */ + CompletableFuture<AsyncSemaphorePermit> acquire(long permits, BooleanSupplier isCancelled); + + /** + * Acquire or release permits for previously acquired permits by updating the permits. + * Returns a future that completes when permits are available. + * It will complete exceptionally with AsyncSemaphorePermitAcquireTimeoutException on timeout + * and exceptionally with AsyncSemaphorePermitAcquireQueueFullException when queue full + * @return CompletableFuture that completes with permit when available + */ Review Comment: The PIP document has been updated to match this implementation. What's missing? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
