#ifndef QPID_CLUSTER_INITIALSTATUSMAP_H
#define QPID_CLUSTER_INITIALSTATUSMAP_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 "MemberSet.h"
#include "qpid/Url.h"
#include <qpid/framing/ClusterInitialStatusBody.h>
#include <boost/optional.hpp>
#include <vector>

namespace qpid {
namespace cluster {

/**
 * Track status of cluster members during initialization.
 *
 * When a new member joins the CPG cluster, all members send an initial-status
 * control. This map tracks those controls and provides data to make descisions
 * about joining the cluster.
 *
 */
class InitialStatusMap
{
  public:
    typedef framing::ClusterInitialStatusBody Status;

    InitialStatusMap(const MemberId& self, size_t size);
    /** Process a config change. May make isResendNeeded() true. */
    void configChange(const MemberSet& newConfig);
    /** @return true if we need to re-send status */
    bool isResendNeeded();

    /** Process received status */
    void received(const MemberId&, const Status& is);

    /**@return true if the map has an entry for all current cluster members. */
    bool isComplete() const;

    size_t getActualSize() const { return map.size(); }
    size_t getRequiredSize() const { return size; }

    /**@return true if the map was completed by the last config change or received. */
    bool transitionToComplete();
    /**@pre isComplete(). @return this node's elders */
    MemberSet getElders() const;
    /**@pre isComplete(). @return True if there are active members of the cluster. */
    bool isActive();
    /**@pre isComplete(). @return True if we need to request an update. */
    bool isUpdateNeeded();
    /**@pre isComplete(). @return Cluster-wide cluster ID. */
    framing::Uuid getClusterId();
    /**@pre isComplete(). @throw Exception if there are any inconsistencies. */
    void checkConsistent();
    /*@return cluster URLs */
    std::vector<Url> getUrls() const;

    /** Get first config-change for this member, encoded as a string.
     *@pre configChange has been called at least once.
     */
    std::string getFirstConfigStr() const;
  private:
    typedef std::map<MemberId, boost::optional<Status> > Map;
    static bool notInitialized(const Map::value_type&);
    static bool isActiveEntry(const Map::value_type&);
    static bool hasStore(const Map::value_type&);

    Map map;
    MemberSet firstConfig;
    MemberId self;
    bool completed, resendNeeded;
    size_t size;
};
}} // namespace qpid::cluster

#endif  /*!QPID_CLUSTER_INITIALSTATUSMAP_H*/
