blob: ca2dd7aa9bca55e75a72417233e0f1629499ba9c [file] [log] [blame]
Ilya Moiseenkoa1214112011-08-29 13:03:55 -07001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011 University of California, Los Angeles
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 *
18 * Author: Ilya Moiseenko <iliamo@cs.ucla.edu>
19 */
20
21#ifndef CCNX_PRODUCER_HELPER_H
22#define CCNX_PRODUCER_HELPER_H
23
24#include <stdint.h>
25#include <string>
26#include "ns3/object-factory.h"
27#include "ns3/address.h"
28#include "ns3/attribute.h"
29#include "ns3/net-device.h"
30#include "ns3/node-container.h"
31#include "ns3/application-container.h"
32#include "ns3/ccnx-name-components.h"
33#include "ns3/pointer.h"
34#include "ns3/ccnx-local-face.h"
35#include "ns3/callback.h"
36#include "ns3/ccnx-producer.h"
37#include "ns3/uinteger.h"
38#include "ns3/ccnx-stack-helper.h"
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -070039#include "ns3/log.h"
40#include "ns3/string.h"
41#include "ns3/names.h"
Ilya Moiseenkoa1214112011-08-29 13:03:55 -070042
43namespace ns3
44{
45/**
46* \brief A helper to make it easier to instantiate an ns3::CcnxProducer application
47* on a set of nodes.
48*/
49
50class CcnxProducerHelper
51{
52public:
53/**
54* Create an CcnxProducerHelper to make it easier to work with CcnxProducer applications
55*
56*/
57CcnxProducerHelper (uint32_t storeCapacity);
58
59/**
60* Helper function used to set the underlying application attributes.
61*
62* \param name the name of the application attribute to set
63* \param value the value of the application attribute to set
64*/
65void SetAttribute (std::string name, const AttributeValue &value);
66
67/**
68* Install an ns3::CcnxProducer on each node of the input container
69* configured with all the attributes set with SetAttribute.
70*
71* \param c NodeContainer of the set of nodes on which an CcnxProducer
72* will be installed.
73* \returns Container of Ptr to the applications installed.
74*/
75ApplicationContainer Install (NodeContainer c);
76
77/**
78* Install an ns3::CcnxProducer on the node configured with all the
79* attributes set with SetAttribute.
80*
81* \param node The node on which an CcnxProducer will be installed.
82* \returns Container of Ptr to the applications installed.
83*/
84ApplicationContainer Install (Ptr<Node> node);
85
86/**
87* Install an ns3::CcnxProducer on the node configured with all the
88* attributes set with SetAttribute.
89*
90* \param nodeName The node on which an CcnxProducer will be installed.
91* \returns Container of Ptr to the applications installed.
92*/
93ApplicationContainer Install (std::string nodeName);
94
95private:
96/**
97* \internal
98* Install an ns3::CcnxProducer on the node configured with all the
99* attributes set with SetAttribute.
100*
101* \param node The node on which an CcnxProducer will be installed.
102* \returns Ptr to the application installed.
103*/
104Ptr<Application> InstallPriv (Ptr<Node> node);
105ObjectFactory m_factory;
106
107};
108}
109
110#endif
111