com.lambdaworks.redis.masterslave.TopologyProvider Maven / Gradle / Ivy

Go to download

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

Advanced and thread-safe Java Redis client for synchronous, asynchronous, and reactive usage. Supports Cluster, Sentinel, Pipelining, Auto-Reconnect, Codecs and much more.

The newest version!

/*
 * Copyright 2011-2016 the original author or authors.
 *
 * 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 com.lambdaworks.redis.masterslave;

import java.util.List;

import com.lambdaworks.redis.RedisException;
import com.lambdaworks.redis.models.role.RedisNodeDescription;

/**
 * Topology provider for Master-Slave topology discovery during runtime. Implementors of this interface return an unordered list
 * of {@link RedisNodeDescription} instances.
 * 
 * @author Mark Paluch
 * @since 4.1
 */
@FunctionalInterface
public interface TopologyProvider {

    /**
     * Lookup nodes within the topology.
     * 
     * @return list of {@link RedisNodeDescription} instances
     * @throws RedisException on errors that occured during the lookup
     */
    List getNodes();
}