candidate-queue.h

Go to the documentation of this file.

/*
 * Copyright 2007 University of Washington
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author:  Craig Dowell (craigdo@ee.washington.edu)
 */
 
#ifndef CANDIDATE_QUEUE_H
#define CANDIDATE_QUEUE_H
 
#include "ns3/ipv4-address.h"
 
#include <list>
#include <stdint.h>
 
namespace ns3
{
 
class SPFVertex;
 
class CandidateQueue
{
  public:
    CandidateQueue();
 
    virtual ~CandidateQueue();
 
    // Delete copy constructor and assignment operator to avoid misuse
    CandidateQueue(const CandidateQueue&) = delete;
    CandidateQueue& operator=(const CandidateQueue&) = delete;
 
    void Clear();
 
    void Push(SPFVertex* vNew);
 
    SPFVertex* Pop();
 
    SPFVertex* Top() const;
 
    bool Empty() const;
 
    uint32_t Size() const;
 
    SPFVertex* Find(const Ipv4Address addr) const;
 
    void Reorder();
 
  private:
    static bool CompareSPFVertex(const SPFVertex* v1, const SPFVertex* v2);
 
    typedef std::list<SPFVertex*> CandidateList_t; 
    CandidateList_t m_candidates;                  
 
    friend std::ostream& operator<<(std::ostream& os, const CandidateQueue& q);
};
 
} // namespace ns3
 
#endif /* CANDIDATE_QUEUE_H */