/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.pulsar.broker.service.streamingdispatch;

import org.apache.bookkeeper.mledger.Entry;
import org.apache.bookkeeper.mledger.ManagedLedger;
import org.apache.pulsar.broker.service.Dispatcher;
import org.apache.pulsar.common.classification.InterfaceStability;

/**
 * A {@link Dispatcher} that'll use {@link StreamingEntryReader} to read entries from {@link ManagedLedger}.
 */
@InterfaceStability.Unstable
public interface StreamingDispatcher extends Dispatcher {

    /**
     * Notify dispatcher issued read entry request has complete.
     * @param entry Entry read.
     * @param ctx   Context passed in when issuing read entries request.
     */
    void readEntryComplete(Entry entry, PendingReadEntryRequest ctx);

    /**
     * Notify dispatcher can issue next read request.
     */
    void canReadMoreEntries(boolean withBackoff);

    /**
     * Notify dispatcher to inform consumers reached end of topic.
     */
    void notifyConsumersEndOfTopic();

    /**
     * @return Name of the dispatcher.
     */
    String getName();
}
