daemon/fw/face-table.hpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
 * Copyright (c) 2014-2016,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NFD 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
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef NFD_DAEMON_FW_FACE_TABLE_HPP
#define NFD_DAEMON_FW_FACE_TABLE_HPP

#include "face/face.hpp"
#include <boost/range/adaptor/indirected.hpp>
#include <boost/range/adaptor/map.hpp>

namespace nfd {

class Forwarder;

/** \brief container of all faces
 */
class FaceTable : noncopyable
{
public:
  explicit
  FaceTable(Forwarder& forwarder);

  VIRTUAL_WITH_TESTS
  ~FaceTable();

  /** \brief add a face
   *
   *  FaceTable obtains shared ownership of the face.
   *  The channel or protocol factory that creates the face may retain ownership.
   */
  VIRTUAL_WITH_TESTS void
  add(shared_ptr<Face> face);

  /** \brief add a special face with a reserved FaceId
   */
  VIRTUAL_WITH_TESTS void
  addReserved(shared_ptr<Face> face, FaceId faceId);

  /** \brief get face by FaceId
   *  \return a face if found, nullptr if not found;
   *          face->shared_from_this() can be used if shared_ptr<Face> is desired
   */
  VIRTUAL_WITH_TESTS Face*
  get(FaceId id) const;

  /** \return count of faces
   */
  size_t
  size() const;

public: // enumeration
  typedef std::map<FaceId, shared_ptr<Face>> FaceMap;

  typedef boost::indirected_range<const boost::select_second_const_range<FaceMap>> ForwardRange;

  /** \brief ForwardIterator for Face&
   */
  typedef boost::range_iterator<ForwardRange>::type const_iterator;

  const_iterator
  begin() const;

  const_iterator
  end() const;

public: // signals
  /** \brief fires after a face is added
   */
  signal::Signal<FaceTable, Face&> afterAdd;

  /** \brief fires before a face is removed
   *
   *  When this signal is emitted, face is still in FaceTable and has valid FaceId.
   */
  signal::Signal<FaceTable, Face&> beforeRemove;

private:
  void
  addImpl(shared_ptr<Face> face, FaceId faceId);

  void
  remove(FaceId faceId);

  ForwardRange
  getForwardRange() const;

private:
  Forwarder& m_forwarder;
  FaceId m_lastFaceId;
  FaceMap m_faces;
};

} // namespace nfd

#endif // NFD_DAEMON_FW_FACE_TABLE_HPP