Ilya Moiseenko | 25f7d4d | 2011-09-29 18:41:06 -0700 | [diff] [blame] | 1 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */ |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 2 | /* |
Ilya Moiseenko | 25f7d4d | 2011-09-29 18:41:06 -0700 | [diff] [blame] | 3 | * Copyright (c) 2011 University of California, Los Angeles |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License version 2 as |
| 7 | * published by the Free Software Foundation; |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 17 | * |
Ilya Moiseenko | 25f7d4d | 2011-09-29 18:41:06 -0700 | [diff] [blame] | 18 | * Author: Ilya Moiseenko <iliamo@cs.ucla.edu> |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 19 | */ |
Ilya Moiseenko | 25f7d4d | 2011-09-29 18:41:06 -0700 | [diff] [blame] | 20 | |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 21 | #ifndef CCNX_FORWARDING_HELPER_H |
| 22 | #define CCNX_FORWARDING_HELPER_H |
| 23 | |
| 24 | #include "ns3/ptr.h" |
| 25 | #include "ns3/nstime.h" |
| 26 | #include "ns3/output-stream-wrapper.h" |
Ilya Moiseenko | 25f7d4d | 2011-09-29 18:41:06 -0700 | [diff] [blame] | 27 | #include "ns3/ccnx.h" |
| 28 | #include "ns3/ccnx-flooding-strategy.h" |
Ilya Moiseenko | 9181afd | 2011-10-28 13:06:14 -0700 | [diff] [blame] | 29 | #include "ns3/ccnx-pit.h" |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 30 | |
| 31 | namespace ns3 { |
| 32 | |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 33 | class Node; |
| 34 | |
| 35 | /** |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 36 | * \ingroup ccnx-helpers |
| 37 | * |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 38 | * \brief a factory to create ns3::CcnxForwardingStrategy objects |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 39 | * |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 40 | * \todo Document this class |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 41 | */ |
| 42 | class CcnxForwardingHelper |
| 43 | { |
| 44 | public: |
Ilya Moiseenko | 25f7d4d | 2011-09-29 18:41:06 -0700 | [diff] [blame] | 45 | /* |
Alexander Afanasyev | 1145314 | 2011-11-25 16:13:33 -0800 | [diff] [blame] | 46 | * \brief Default constructor |
Ilya Moiseenko | 25f7d4d | 2011-09-29 18:41:06 -0700 | [diff] [blame] | 47 | */ |
| 48 | CcnxForwardingHelper(); |
Ilya Moiseenko | 25f7d4d | 2011-09-29 18:41:06 -0700 | [diff] [blame] | 49 | |
Alexander Afanasyev | 1145314 | 2011-11-25 16:13:33 -0800 | [diff] [blame] | 50 | // /** |
| 51 | // * \brief prints the forwarding tables of all nodes at a particular time. |
| 52 | // * \param printTime the time at which the forwarding table is supposed to be printed. |
| 53 | // * \param stream The output stream object to use |
| 54 | // * |
| 55 | // * This method calls the PrintForwardingTable() method of the |
| 56 | // * CcnxForwardingStrategy stored in the Ccnx object, for all nodes at the |
| 57 | // * specified time; the output format is forwarding protocol-specific. |
| 58 | // */ |
| 59 | // void PrintForwardingTableAllAt (Time printTime, Ptr<OutputStreamWrapper> stream) const; |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 60 | |
Alexander Afanasyev | 1145314 | 2011-11-25 16:13:33 -0800 | [diff] [blame] | 61 | // /** |
| 62 | // * \brief prints the forwarding tables of all nodes at regular intervals specified by user. |
| 63 | // * \param printInterval the time interval for which the forwarding table is supposed to be printed. |
| 64 | // * \param stream The output stream object to use |
| 65 | // * |
| 66 | // * This method calls the PrintForwardingTable() method of the |
| 67 | // * CcnxForwardingStrategy stored in the Ccnx object, for all nodes at the |
| 68 | // * specified time interval; the output format is forwarding protocol-specific. |
| 69 | // */ |
| 70 | // void PrintForwardingTableAllEvery (Time printInterval, Ptr<OutputStreamWrapper> stream) const; |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 71 | |
Alexander Afanasyev | 1145314 | 2011-11-25 16:13:33 -0800 | [diff] [blame] | 72 | // /** |
| 73 | // * \brief prints the forwarding tables of a node at a particular time. |
| 74 | // * \param printTime the time at which the forwarding table is supposed to be printed. |
| 75 | // * \param node The node ptr for which we need the forwarding table to be printed |
| 76 | // * \param stream The output stream object to use |
| 77 | // * |
| 78 | // * This method calls the PrintForwardingTable() method of the |
| 79 | // * CcnxForwardingStrategy stored in the Ccnx object, for the selected node |
| 80 | // * at the specified time; the output format is forwarding protocol-specific. |
| 81 | // */ |
| 82 | // void PrintForwardingTableAt (Time printTime, Ptr<Node> node, Ptr<OutputStreamWrapper> stream) const; |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 83 | |
Alexander Afanasyev | 1145314 | 2011-11-25 16:13:33 -0800 | [diff] [blame] | 84 | // /** |
| 85 | // * \brief prints the forwarding tables of a node at regular intervals specified by user. |
| 86 | // * \param printInterval the time interval for which the forwarding table is supposed to be printed. |
| 87 | // * \param node The node ptr for which we need the forwarding table to be printed |
| 88 | // * \param stream The output stream object to use |
| 89 | // * |
| 90 | // * This method calls the PrintForwardingTable() method of the |
| 91 | // * CcnxForwardingStrategy stored in the Ccnx object, for the selected node |
| 92 | // * at the specified interval; the output format is forwarding protocol-specific. |
| 93 | // */ |
| 94 | // void PrintForwardingTableEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream) const; |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 95 | |
| 96 | private: |
Alexander Afanasyev | 1145314 | 2011-11-25 16:13:33 -0800 | [diff] [blame] | 97 | // void Print (Ptr<Node> node, Ptr<OutputStreamWrapper> stream) const; |
| 98 | // void PrintEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream) const; |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 99 | }; |
| 100 | |
| 101 | } // namespace ns3 |
| 102 | |
| 103 | |
| 104 | #endif /* CCNX_FORWARDING_HELPER_H */ |