#ifndef QPID_CLUSTER_EXPIRYPOLICY_H
#define QPID_CLUSTER_EXPIRYPOLICY_H

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

#include "qpid/cluster/types.h"
#include "qpid/broker/ExpiryPolicy.h"
#include "qpid/sys/Mutex.h"
#include <boost/function.hpp>
#include <boost/intrusive_ptr.hpp>
#include <boost/optional.hpp>
#include <map>

namespace qpid {

namespace broker {
class Message;
}

namespace sys {
class Timer;
}

namespace cluster {
class Multicaster;

/**
 * Cluster expiry policy
 */
class ExpiryPolicy : public broker::ExpiryPolicy
{
  public:
    ExpiryPolicy(Multicaster&, const MemberId&, sys::Timer&);

    void willExpire(broker::Message&);
    bool hasExpired(broker::Message&);
    void forget(broker::Message&);

    // Send expiration notice to cluster.
    void sendExpire(uint64_t);

    // Cluster delivers expiry notice.
    void deliverExpire(uint64_t);

    void setId(uint64_t id);
    uint64_t getId() const;
    
    boost::optional<uint64_t> getId(broker::Message&);
    
  private:
    typedef std::map<broker::Message*,  uint64_t> MessageIdMap;
    // When messages are fanned out to multiple queues, update sends
    // them as independenty messages so we can have multiple messages
    // with the same expiry ID.
    typedef std::multimap<uint64_t, broker::Message*> IdMessageMap;

    struct Expired : public broker::ExpiryPolicy {
        bool hasExpired(broker::Message&);
        void willExpire(broker::Message&);
    };

    mutable sys::Mutex lock;
    MessageIdMap unexpiredByMessage;
    IdMessageMap unexpiredById;
    uint64_t expiryId;
    boost::intrusive_ptr<Expired> expiredPolicy;
    Multicaster& mcast;
    MemberId memberId;
    sys::Timer& timer;
};

}} // namespace qpid::cluster

#endif  /*!QPID_CLUSTER_EXPIRYPOLICY_H*/