com.wandoulabs.nedis.ConnectionManagement 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.channel.EventLoop;
import io.netty.util.concurrent.Future;

/**
 * @author Apache9
 */
public interface ConnectionManagement extends AsyncCloseable {
    /**
     * return previous timeout value. Possible null if the client is already closed.
     */
    Future setTimeout(long timeoutMs);

    /**
     * return the {@link EventLoop} of the underline {@link io.netty.channel.Channel}.
     */
    EventLoop eventLoop();

    /**
     * return whether the client is still open.
     */
    boolean isOpen();

    /**
     * return the client to its pool if:
     * 
     * The client is created by a {@link NedisClientPool}.
     * The pool is {@code exclusive}.
     * 
     */
    void release();
}