io.github.bucket4j.distributed.AsyncOptimizationController Maven / Gradle / Ivy

Go to download
/*-
 * ========================LICENSE_START=================================
 * Bucket4j
 * %%
 * Copyright (C) 2015 - 2021 Vladimir Bukhtoyarov
 * %%
 * Licensed 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.
 * =========================LICENSE_END==================================
 */
package io.github.bucket4j.distributed;

import io.github.bucket4j.distributed.proxy.RemoteAsyncBucketBuilder;
import io.github.bucket4j.distributed.proxy.optimization.Optimization;

import java.time.Duration;
import java.util.concurrent.CompletableFuture;

/**
 * The optimization controller for {@link AsyncBucketProxy}.
 *
 * 
 * This interface is actual only if an optimization was applied during bucket construction via {@link RemoteAsyncBucketBuilder#withOptimization(Optimization)}
 * otherwise all methods of controller will do nothing.
 */
public interface AsyncOptimizationController {

    /**
     * Initiates immediate synchronization of local copy of bucket with remote storage
     *
     * @return future that will be completed when local copy of bucket will be synchronized with remote storage,
     * or immediately completed future in case of this synchronization is not required.
     */
    default CompletableFuture syncImmediately() {
        return syncByCondition(0L, Duration.ZERO);
    }

    /**
     * Initiates immediate synchronization of local copy of bucket with remote storage in case of both conditions bellow are {@code true}:
     * 

     *     Accumulated amount of locally consumed tokens without external synchronization is greater than or equal to {@code unsynchronizedTokens}
     *     Time passed since last synchronization with external storage is greater than or equal to {@code timeSinceLastSync}
     * 
     *
     * @param unsynchronizedTokens criterion for accumulated amount of unsynchronized tokens
     * @param timeSinceLastSync criterion for time passed since last synchronization
     *
     * @return future that will be completed when local copy of bucket will be synchronized with remote storage,
     * or immediately completed future in case of this synchronization is not required.
     */
    CompletableFuture syncByCondition(long unsynchronizedTokens, Duration timeSinceLastSync);

}