All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.redisson.api.RBucketReactive Maven / Gradle / Ivy

Go to download

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2
Show newest version
/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * 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.
 */
package org.redisson.api;

import reactor.core.publisher.Mono;

import java.time.Duration;
import java.time.Instant;
import java.util.concurrent.TimeUnit;


/**
 * Reactive implementation of object holder. Max size of object is 512MB
 *
 * @author Nikita Koksharov
 *
 * @param  - the type of object
 */
public interface RBucketReactive extends RExpirableReactive {

    /**
     * Returns size of object in bytes
     * 
     * @return object size
     */
    Mono size();

    /**
     * Sets value only if object holder doesn't exist.
     *
     * @param value - value to set
     * @return {@code true} if successful, or {@code false} if
     *         element was already set
     */
    Mono setIfAbsent(V value);

    /**
     * Sets value with defined duration only if object holder doesn't exist.
     *
     * @param value value to set
     * @param duration expiration duration
     * @return {@code true} if successful, or {@code false} if
     *         element was already set
     */
    Mono setIfAbsent(V value, Duration duration);

    /**
     * Use {@link #setIfAbsent(Object)} instead
     * 
     * @param value - value to set
     * @return {@code true} if successful, or {@code false} if
     *         element was already set
     */
    @Deprecated
    Mono trySet(V value);

    /**
     * Use {@link #setIfAbsent(Object, Duration)} instead
     * 
     * @param value - value to set
     * @param timeToLive - time to live interval
     * @param timeUnit - unit of time to live interval
     * @return {@code true} if successful, or {@code false} if
     *         element was already set
     */
    @Deprecated
    Mono trySet(V value, long timeToLive, TimeUnit timeUnit);

    /**
     * Sets value only if it's already exists.
     *
     * @param value - value to set
     * @return {@code true} if successful, or {@code false} if
     *         element wasn't set
     */
    Mono setIfExists(V value);

    /**
     * Use {@link #setIfExists(Object, Duration)} instead
     *
     * @param value - value to set
     * @param timeToLive - time to live interval
     * @param timeUnit - unit of time to live interval
     * @return {@code true} if successful, or {@code false} if
     *         element wasn't set
     */
    @Deprecated
    Mono setIfExists(V value, long timeToLive, TimeUnit timeUnit);

    /**
     * Sets value with expiration duration only if object holder already exists.
     *
     * @param value value to set
     * @param duration expiration duration
     * @return {@code true} if successful, or {@code false} if
     *         element wasn't set
     */
    Mono setIfExists(V value, Duration duration);

    /**
     * Atomically sets the value to the given updated value
     * only if serialized state of the current value equals 
     * to serialized state of the expected value.
     *
     * @param expect the expected value
     * @param update the new value
     * @return {@code true} if successful; or {@code false} if the actual value
     *         was not equal to the expected value.
     */
    Mono compareAndSet(V expect, V update);

    /**
     * Retrieves current element in the holder and replaces it with newValue. 
     * 
     * @param newValue - value to set
     * @return previous value
     */
    Mono getAndSet(V newValue);

    /**
     * Use {@link #getAndSet(Object, Duration)} instead
     * 
     * @param value - value to set
     * @param timeToLive - time to live interval
     * @param timeUnit - unit of time to live interval
     * @return previous value
     */
    @Deprecated
    Mono getAndSet(V value, long timeToLive, TimeUnit timeUnit);

    /**
     * Retrieves current element in the holder and replaces it
     * with value with defined expiration duration.
     *
     * @param value value to set
     * @param duration expiration duration
     * @return previous value
     */
    Mono getAndSet(V value, Duration duration);

    /**
     * Retrieves current element in the holder and sets an expiration duration for it.
     * 

* Requires Redis 6.2.0 and higher. * * @param duration of object time to live interval * @return element */ Mono getAndExpire(Duration duration); /** * Retrieves current element in the holder and sets an expiration date for it. *

* Requires Redis 6.2.0 and higher. * * @param time of exact object expiration moment * @return element */ Mono getAndExpire(Instant time); /** * Retrieves current element in the holder and clears expiration date set before. *

* Requires Redis 6.2.0 and higher. * * @return element */ Mono getAndClearExpire(); /** * Retrieves element stored in the holder. * * @return element */ Mono get(); /** * Retrieves element in the holder and removes it. * * @return element */ Mono getAndDelete(); /** * Stores element into the holder. * * @param value - value to set * @return void */ Mono set(V value); /** * Use {@link #set(Object, Duration)} instead * * @param value - value to set * @param timeToLive - time to live interval * @param timeUnit - unit of time to live interval * @return void */ @Deprecated Mono set(V value, long timeToLive, TimeUnit timeUnit); /** * Stores value into the holder with defined expiration duration. * * @param value value to set * @param duration expiration duration */ Mono set(V value, Duration duration); /** * Set value and keep existing TTL. *

* Requires Redis 6.0.0 and higher. * * @param value - value to set * @return void */ Mono setAndKeepTTL(V value); /** * Adds object event listener * * @see org.redisson.api.listener.TrackingListener * @see org.redisson.api.ExpiredObjectListener * @see org.redisson.api.DeletedObjectListener * @see org.redisson.api.listener.SetObjectListener * * @param listener - object event listener * @return listener id */ Mono addListener(ObjectListener listener); /** * Returns the common part of the data stored in this bucket * and a bucket defined by the name * * @param name second bucket * @return common part of the data */ Mono findCommon(String name); /** * Returns the length of the common part of the data stored in this bucket * and a bucket defined by the name * * @param name second bucket * @return common part of the data */ Mono findCommonLength(String name); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy