com.wandoulabs.nedis.NedisClientPool Maven / Gradle / Ivy

Go to download

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

There is a newer version: 0.1.1

/**
 * Copyright (c) 2015 Wandoujia Inc.
 *
 * 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.wandoulabs.nedis;

import io.netty.util.concurrent.Future;

/**
 * @author Apache9
 */
public interface NedisClientPool extends AsyncCloseable {

    /**
     * Acquire a {@link NedisClient} from this pool.
     */
    Future acquire();

    /**
     * Return a {@link NedisClient} to this pool.
     * 
     * Usually you should not call this method directly, call {@link NedisClient#release()} instead.
     */
    void release(NedisClient client);

    /**
     * Whether we should remove the {@link NedisClient} from pool when acquiring.
     * 

     * If you are doing time-consuming operations(such as {@code BLPOP}) then you should set this to
     * {@code true}
     */
    boolean exclusive();

    /**
     * Total number of alive {@link NedisClient}s.
     * 
     * This could be larger than {@link #numPooledConns()} if {@link #exclusive()} is {@code true}.
     */
    int numConns();

    /**
     * Number of {@link NedisClient}s in pool.
     */
    int numPooledConns();
}