org.redisson.api.redisnode.RedisNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation

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

The 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.redisnode;

import org.redisson.client.protocol.Time;

import java.net.InetSocketAddress;
import java.time.Instant;
import java.util.Map;
import java.util.concurrent.TimeUnit;

/**
 * Base Redis node API interface
 *
 * @author Nikita Koksharov
 *
 */
public interface RedisNode {

    /**
     * Returns Redis memory statistics
     *
     * @return statistics info map
     */
    Map getMemoryStatistics();

    /**
     * Returns current Redis server time in seconds
     *
     * @return time in seconds
     */
    Time time();

    /**
     * Get Redis node address
     *
     * @return node address
     */
    InetSocketAddress getAddr();

    /**
     * Ping Redis node.
     * Default timeout is 1000 milliseconds
     *
     * @return true if "PONG" reply received, false otherwise
     */
    boolean ping();

    /**
     * Ping Redis node with specified timeout.
     *
     * @param timeout - ping timeout
     * @param timeUnit - timeout unit
     * @return true if "PONG" reply received, false otherwise
     */
    boolean ping(long timeout, TimeUnit timeUnit);

    enum InfoSection {ALL, DEFAULT, SERVER, CLIENTS, MEMORY, PERSISTENCE, STATS, REPLICATION, CPU, COMMANDSTATS, CLUSTER, KEYSPACE}

    /**
     * Returns information about Redis node.
     *
     * @param section - section of information
     * @return information
     */
    Map info(RedisNode.InfoSection section);

    /**
     * Get value of Redis configuration parameter.
     *
     * @param parameter - name of parameter
     * @return value of parameter
     */
    Map getConfig(String parameter);

    /**
     * Set value of Redis configuration parameter.
     *
     * @param parameter - name of parameter
     * @param value - value of parameter
     */
    void setConfig(String parameter, String value);

    /**
     * Runs the Redis database saving process in background.
     *
     */
    void bgSave();

    /**
     * Save the Redis database in background.
     * If AOF rewrite process is in progress then
     * the background save is scheduled to run upon its completion.
     *
     */
    void scheduleBgSave();

    /**
     * Save the Redis database.
     *
     */
    void save();

    /**
     * Returns time of the last successful
     * Redis database save operation.
     *
     * @return time
     */
    Instant getLastSaveTime();

    /**
     * Runs an Append Only File rewrite process.
     * Starts only if there is no a background process doing persistence.
     * 
     * If fails no data gets lost
     *
     */
    void bgRewriteAOF();

    /**
     * Returns keys amount stored in this Redis node.
     *
     * @return keys amount
     */
    long size();

}