/*
*
* 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.qpid.server.queue;

import org.apache.qpid.server.message.BaseMessageInstance;
import org.apache.qpid.server.message.MessageInstanceConsumer;
import org.apache.qpid.server.message.ServerMessage;
import org.apache.qpid.server.store.MessageEnqueueRecord;
import org.apache.qpid.server.txn.ServerTransaction;
import org.apache.qpid.server.util.Action;

public interface QueueEntryList
{
    RecoverableBaseQueue getQueue();

    QueueEntry add(ServerMessage message, final MessageEnqueueRecord enqueueRecord);

    QueueEntry next(QueueEntry node);

    QueueEntryIterator iterator();

    QueueEntry getHead();

    QueueEntry getTail();

    QueueEntry getOldestEntry();

    void entryDeleted(QueueEntry queueEntry);
    
    int getPriorities();

    void onAcquiredByConsumer(QueueEntry queueEntry, final MessageInstanceConsumer consumer);

    void onNoLongerAcquiredByConsumer(QueueEntry queueEntry);

    void requeue(QueueEntry queueEntry);

    boolean isHeld(QueueEntry queueEntry, long evaluationTime);

    void dequeue(QueueEntry queueEntry);

    int routeToAlternate(QueueEntry queueEntry, Action<? super BaseMessageInstance> action, ServerTransaction txn);

    int getMaximumDeliveryAttempts();
}