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

Go to download

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

Redis Java client with features of In-Memory Data Grid

There is a newer version: 3.45.1

/**
 * Copyright (c) 2013-2021 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.Collection;
import java.util.concurrent.TimeUnit;

import org.redisson.connection.ConnectionListener;

/**
 *
 * @author Nikita Koksharov
 *
 */
@Deprecated
public interface NodesGroup {

    /**
     * Adds connection listener which will be triggered
     * when Redisson connected to or disconnected from Redis server
     *
     * @param connectionListener - connection listener
     * @return id of listener
     */
    int addConnectionListener(ConnectionListener connectionListener);

    /**
     * Removes connection listener by id
     *
     * @param listenerId - id of connection listener
     */
    void removeConnectionListener(int listenerId);

    /**
     * Get Redis node by address in format: redis://host:port
     * 
     * @param address of node
     * @return node
     */
    N getNode(String address);
    
    /**
     * Get all Redis nodes by type
     *
     * @param type - type of node
     * @return collection of nodes
     */
    Collection getNodes(NodeType type);

    /**
     * All Redis nodes used by Redisson.
     * This collection may change during master change, cluster topology update and etc.
     *
     * @return collection of nodes
     */
    Collection getNodes();

    /**
     * Ping all Redis nodes.
     * Default timeout per Redis node is 1000 milliseconds
     *
     * @return true if all nodes replied "PONG", false in other case.
     */
    boolean pingAll();

    /**
     * Ping all Redis nodes with specified timeout per node
     *
     * @return true if all nodes replied "PONG", false in other case.
     */
    boolean pingAll(long timeout, TimeUnit timeUnit);

}