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

org.redisson.api.RObjectAsync 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 java.util.concurrent.TimeUnit;

/**
 * Base asynchronous interface for all Redisson objects
 *
 * @author Nikita Koksharov
 *
 */
public interface RObjectAsync {

    /**
     * Returns number of seconds spent since last write or read operation over this object.
     *
     * @return number of seconds
     */
    RFuture getIdleTimeAsync();

    /**
     * Returns bytes amount used by object in Redis memory. 
     * 
     * @return size in bytes
     */
    RFuture sizeInMemoryAsync();
    
    /**
     * Restores object using its state returned by {@link #dumpAsync()} method.
     * 
     * @param state - state of object
     * @return void
     */
    RFuture restoreAsync(byte[] state);
    
    /**
     * Restores object using its state returned by {@link #dumpAsync()} method and set time to live for it.
     * 
     * @param state - state of object
     * @param timeToLive - time to live of the object
     * @param timeUnit - time unit
     * @return void
     */
    RFuture restoreAsync(byte[] state, long timeToLive, TimeUnit timeUnit);
    
    /**
     * Restores and replaces object if it already exists.
     * 
     * @param state - state of the object
     * @return void
     */
    RFuture restoreAndReplaceAsync(byte[] state);
    
    /**
     * Restores and replaces object if it already exists and set time to live for it.
     * 
     * @param state - state of the object
     * @param timeToLive - time to live of the object
     * @param timeUnit - time unit
     * @return void
     */
    RFuture restoreAndReplaceAsync(byte[] state, long timeToLive, TimeUnit timeUnit);

    /**
     * Returns dump of object
     * 
     * @return dump
     */
    RFuture dumpAsync();
    
    /**
     * Update the last access time of an object in async mode. 
     * 
     * @return true if object was touched else false
     */
    RFuture touchAsync();
    
    /**
     * Transfer object from source Redis instance to destination Redis instance
     * in async mode
     *
     * @param host - destination host
     * @param port - destination port
     * @param database - destination database
     * @param timeout - maximum idle time in any moment of the communication with the destination instance in milliseconds
     * @return void
     */
    RFuture migrateAsync(String host, int port, int database, long timeout);

    /**
     * Copy object from source Redis instance to destination Redis instance
     * in async mode
     *
     * @param host - destination host
     * @param port - destination port
     * @param database - destination database
     * @param timeout - maximum idle time in any moment of the communication with the destination instance in milliseconds
     * @return void
     */
    RFuture copyAsync(String host, int port, int database, long timeout);

    /**
     * Copy this object instance to the new instance with a defined name.
     *
     * @param destination name of the destination instance
     * @return true if this object instance was copied else false
     */
    RFuture copyAsync(String destination);

    /**
     * Copy this object instance to the new instance with a defined name and database.
     *
     * @param destination name of the destination instance
     * @param database database number
     * @return true if this object instance was copied else false
     */
    RFuture copyAsync(String destination, int database);

    /**
     * Copy this object instance to the new instance with a defined name, and replace it if it already exists.
     *
     * @param destination name of the destination instance
     * @return true if this object instance was copied else false
     */
    RFuture copyAndReplaceAsync(String destination);

    /**
     * Copy this object instance to the new instance with a defined name and database, and replace it if it already exists.
     *
     * @param destination name of the destination instance
     * @param database database number
     * @return true if this object instance was copied else false
     */
    RFuture copyAndReplaceAsync(String destination, int database);

    /**
     * Move object to another database in async mode
     *
     * @param database - number of Redis database
     * @return true if key was moved false if not
     */
    RFuture moveAsync(int database);

    /**
     * Delete object in async mode
     *
     * @return true if object was deleted false if not
     */
    RFuture deleteAsync();

    /**
     * Delete the objects.
     * Actual removal will happen later asynchronously.
     * 

* Requires Redis 4.0+ * * @return true if it was exist and deleted else false */ RFuture unlinkAsync(); /** * Rename current object key to newName * in async mode * * @param newName - new name of object * @return void */ RFuture renameAsync(String newName); /** * Rename current object key to newName * in async mode only if new key is not exists * * @param newName - new name of object * @return true if object has been renamed successfully and false otherwise */ RFuture renamenxAsync(String newName); /** * Check object existence in async mode. * * @return true if object exists and false otherwise */ RFuture isExistsAsync(); /** * Adds object event listener * * @see org.redisson.api.ExpiredObjectListener * @see org.redisson.api.DeletedObjectListener * * @param listener - object event listener * @return listener id */ RFuture addListenerAsync(ObjectListener listener); /** * Removes object event listener * * @param listenerId - listener id */ RFuture removeListenerAsync(int listenerId); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy