org.darkphoenixs.kafka.pool.MessageReceiverPool Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015-2016 Dark Phoenixs (Open-Source Organization).
 *
 * 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.darkphoenixs.kafka.pool;

import org.darkphoenixs.kafka.core.KafkaMessageReceiver;

/**
 * MessageReceiverPool
 * 消息接收器池接口
 *
 * @author Victor.Zxy
 * @version 1.3.0
 * @since 2016年7月21日
 */
public interface MessageReceiverPool {

    /**
     * init
     * 初始化池
     */
    public void init();

    /**
     * destroy
     * 销毁池
     */
    public void destroy();

    /**
     * isRunning
     * 是否运行
     *
     * @return 是否运行
     * @since 1.4.6
     */
    public boolean isRunning();

    /**
     * getReceiver
     * 获得接收器
     *
     * @return 接收器
     */
    public KafkaMessageReceiver getReceiver();

    /**
     * returnReceiver
     * 释放接收器
     *
     * @param receiver 接收器
     */
    public void returnReceiver(KafkaMessageReceiver receiver);

}