| /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */ |
| /* |
| * Copyright (c) 2011 University of California, Los Angeles |
| * |
| * 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: Alexander Afanasyev <alexander.afanasyev@ucla.edu> |
| */ |
| |
| #ifndef _NDN_H_ |
| #define _NDN_H_ |
| |
| #include "ns3/object.h" |
| #include "ns3/callback.h" |
| #include "ns3/traced-callback.h" |
| |
| namespace ns3 { |
| |
| class Node; |
| class NetDevice; |
| class Packet; |
| class NdnForwardingStrategy; |
| class NdnFace; |
| class NdnContentObjectHeader; |
| class NdnInterestHeader; |
| class NdnPit; |
| |
| /// @cond include_hidden |
| /** |
| * \internal |
| * \brief Private namespace for Ndn content store implementation |
| */ |
| namespace __ndn_private |
| { |
| class i_face {}; |
| class i_metric {}; |
| class i_nth {}; |
| class i_prefix {}; |
| class i_ordered {}; ///< tag for Boost.MultiIndex container (ordered by prefix) |
| class i_mru {}; |
| } |
| /// @endcond |
| |
| // default data size |
| // #define NDN_DEFAULT_DATA_SIZE 1024 |
| // #define NDN_INTEREST_RESET_PERIOD (10*MILLI_SECOND) |
| |
| /** |
| * \defgroup ndn NDN abstraction |
| * |
| * This is an abstract implementation of NDN protocol |
| */ |
| /** |
| * \ingroup ndn |
| * \brief Interface to manage Ndn stack |
| * |
| * This class defines the API to manipulate the following aspects of |
| * the Ndn stack implementation: |
| * -# register a face (NdnFace-derived object) for use by the Ndn |
| * layer |
| * -# register forwarding strategy (NdnForwardingStrategy-derived |
| * object) to use by Ndn stack |
| * -# export Ndn configuration attributes |
| * |
| * Each NdnFace-derived object has conceptually a single Ndn |
| * interface associated with it. |
| * |
| * In addition, this class defines Ndn packet coding constants |
| * |
| * \see NdnFace, NdnForwardingStrategy |
| */ |
| class Ndn : public Object |
| { |
| public: |
| /** |
| * \brief Interface ID |
| * |
| * \return interface ID |
| */ |
| static TypeId GetTypeId (); |
| virtual ~Ndn (); |
| |
| /** |
| * \brief Add face to Ndn stack |
| * |
| * \param face smart pointer to NdnFace-derived object |
| * (NdnLocalFace, NdnNetDeviceFace, NdnUdpFace) \returns the |
| * index of the Ndn interface added. |
| * |
| * \see NdnLocalFace, NdnNetDeviceFace, NdnUdpFace |
| */ |
| virtual uint32_t |
| AddFace (const Ptr<NdnFace> &face) = 0; |
| |
| /** |
| * \brief Get current number of faces added to Ndn stack |
| * |
| * \returns the number of faces |
| */ |
| virtual uint32_t |
| GetNFaces (void) const = 0; |
| |
| /** |
| * \brief Get face by face index |
| * \param face The face number of an Ndn interface. |
| * \returns The NdnFace associated with the Ndn face number. |
| */ |
| virtual Ptr<NdnFace> |
| GetFace (uint32_t face) const = 0; |
| |
| /** |
| * \brief Remove face from ndn stack (remove callbacks) |
| */ |
| virtual void |
| RemoveFace (Ptr<NdnFace> face) = 0; |
| |
| /** |
| * \brief Get face for NetDevice |
| */ |
| virtual Ptr<NdnFace> |
| GetFaceByNetDevice (Ptr<NetDevice> netDevice) const = 0; |
| |
| // /** |
| // * \enum DropReason |
| // * \brief A reason why the packet has been dropped |
| // */ |
| // enum DropReason |
| // { |
| // DUPLICATED, // Interests |
| // SUPPRESSED, // Interests and Nacks |
| // NO_FACES, // Interests |
| // NON_DUPLICATED, // Nacks |
| // AFTER_SATISFIED, // Nacks |
| // UNSOLICITED, // data |
| // PIT_LIMIT // PIT limit reached |
| // }; |
| }; |
| |
| } // namespace ns3 |
| |
| #endif /* _NDN_H_ */ |