/*
 * 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.
 */

/**
 * \file AsyncStoreImpl.h
 */

#ifndef qpid_asyncStore_AsyncStoreImpl_h_
#define qpid_asyncStore_AsyncStoreImpl_h_

#include "qpid/asyncStore/AsyncStoreOptions.h"
#include "qpid/asyncStore/jrnl2/RecordIdCounter.h"
#include "qpid/asyncStore/RunState.h"
#include "qpid/asyncStore/OperationQueue.h"
#include "qpid/broker/AsyncStore.h"

namespace qpid {
namespace broker {
class Broker;
}

namespace sys {
class Poller;
}

namespace asyncStore {

class AsyncStoreImpl : public qpid::broker::AsyncStore
{
public:
    AsyncStoreImpl(boost::shared_ptr<qpid::sys::Poller> poller,
                   const AsyncStoreOptions& opts);
    virtual ~AsyncStoreImpl();
    void initialize(bool truncateFlag = false, bool saveFlag = true);
    uint64_t getNextRid(); // Global counter for journal RIDs

    // --- Management ---

    void initManagement(qpid::broker::Broker* broker);

    // --- Interface from AsyncTransactionalStore ---

    qpid::broker::TxnHandle createTxnHandle();
    qpid::broker::TxnHandle createTxnHandle(qpid::broker::SimpleTxnBuffer* tb);
    qpid::broker::TxnHandle createTxnHandle(const std::string& xid,
                                            const bool tpcFlag);
    qpid::broker::TxnHandle createTxnHandle(const std::string& xid,
                                            const bool tpcFlag,
                                            qpid::broker::SimpleTxnBuffer* tb);

    void submitPrepare(qpid::broker::TxnHandle& txnHandle,
                       boost::shared_ptr<qpid::broker::TpcTxnAsyncContext> txnCtxt);
    void submitCommit(qpid::broker::TxnHandle& txnHandle,
                      boost::shared_ptr<qpid::broker::TxnAsyncContext> txnCtxt);
    void submitAbort(qpid::broker::TxnHandle& txnHandle,
                     boost::shared_ptr<qpid::broker::TxnAsyncContext> txnCtxt);


    // --- Interface from AsyncRecoverable ---
    qpid::broker::RecoveryHandle createRecoveryHandle();
    void submitRecover(qpid::broker::RecoveryHandle& rcvrHandle,
                       boost::shared_ptr<qpid::broker::RecoveryAsyncContext> rcvrCtxt);


    // --- Interface from AsyncStore ---

    qpid::broker::ConfigHandle createConfigHandle();
    qpid::broker::EnqueueHandle createEnqueueHandle(qpid::broker::MessageHandle& msgHandle,
                                                    qpid::broker::QueueHandle& queueHandle);
    qpid::broker::EventHandle createEventHandle(qpid::broker::QueueHandle& queueHandle,
                                                const std::string& key=std::string());
    qpid::broker::MessageHandle createMessageHandle(const qpid::broker::DataSource* const dataSrc);
    qpid::broker::QueueHandle createQueueHandle(const std::string& name,
                                                const qpid::types::Variant::Map& opts);

    void submitCreate(qpid::broker::ConfigHandle& cfgHandle,
                      const qpid::broker::DataSource* const dataSrc,
                      boost::shared_ptr<qpid::broker::BrokerAsyncContext> brokerCtxt);
    void submitDestroy(qpid::broker::ConfigHandle& cfgHandle,
                       boost::shared_ptr<qpid::broker::BrokerAsyncContext> brokerCtxt);

    void submitCreate(qpid::broker::QueueHandle& queueHandle,
                      const qpid::broker::DataSource* const dataSrc,
                      boost::shared_ptr<qpid::broker::QueueAsyncContext> QueueCtxt);
    void submitDestroy(qpid::broker::QueueHandle& queueHandle,
                       boost::shared_ptr<qpid::broker::QueueAsyncContext> QueueCtxt);
    void submitFlush(qpid::broker::QueueHandle& queueHandle,
                     boost::shared_ptr<qpid::broker::QueueAsyncContext> QueueCtxt);

    void submitCreate(qpid::broker::EventHandle& eventHandle,
                      const qpid::broker::DataSource* const dataSrc,
                      qpid::broker::TxnHandle& txnHandle,
                      boost::shared_ptr<qpid::broker::BrokerAsyncContext> brokerCtxt);
    void submitDestroy(qpid::broker::EventHandle& eventHandle,
                      qpid::broker::TxnHandle& txnHandle,
                      boost::shared_ptr<qpid::broker::BrokerAsyncContext> brokerCtxt);

    void submitEnqueue(qpid::broker::EnqueueHandle& enqHandle,
                       qpid::broker::TxnHandle& txnHandle,
                       boost::shared_ptr<qpid::broker::QueueAsyncContext> QueueCtxt);
    void submitDequeue(qpid::broker::EnqueueHandle& enqHandle,
                       qpid::broker::TxnHandle& txnHandle,
                       boost::shared_ptr<qpid::broker::QueueAsyncContext> QueueCtxt);

//    // Legacy - Restore FTD message, is NOT async!
//    virtual int loadContent(qpid::broker::MessageHandle& msgHandle,
//                            qpid::broker::QueueHandle& queueHandle,
//                            char* data,
//                            uint64_t offset,
//                            const uint64_t length);

private:
    boost::shared_ptr<qpid::sys::Poller> m_poller;
    AsyncStoreOptions m_opts;
    RunState m_runState;
    OperationQueue m_operations;
    qpid::asyncStore::jrnl2::RecordIdCounter_t m_ridCntr;
};

}} // namespace qpid::asyncStore

#endif // qpid_asyncStore_AsyncStoreImpl_h_