Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(728)

Unified Diff: src/nist/helper/nist-packet-sink-helper.h

Issue 326890043: Public Safety Communication modeling tools based on ns-3
Patch Set: Created 6 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/nist/helper/nist-on-off-helper.cc ('k') | src/nist/helper/nist-packet-sink-helper.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/nist/helper/nist-packet-sink-helper.h
===================================================================
new file mode 100644
--- /dev/null
+++ b/src/nist/helper/nist-packet-sink-helper.h
@@ -0,0 +1,100 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2008 INRIA
+ *
+ * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
+ */
+#ifndef NIST_PACKET_SINK_HELPER_H
+#define NIST_PACKET_SINK_HELPER_H
+
+#include "ns3/object-factory.h"
+#include "ns3/ipv4-address.h"
+#include "ns3/node-container.h"
+#include "ns3/application-container.h"
+
+namespace ns3 {
+
+/**
+ * \ingroup packetsink
+ * \brief A helper to make it easier to instantiate an ns3::PacketSinkApplication
+ * on a set of nodes.
+ */
+class NistPacketSinkHelper
+{
+public:
+ /**
+ * Create a NistPacketSinkHelper to make it easier to work with PacketSinkApplications
+ *
+ * \param protocol the name of the protocol to use to receive traffic
+ * This string identifies the socket factory type used to create
+ * sockets for the applications. A typical value would be
+ * ns3::TcpSocketFactory.
+ * \param address the address of the sink,
+ *
+ */
+ NistPacketSinkHelper (std::string protocol, Address address);
+
+ /**
+ * Helper function used to set the underlying application attributes.
+ *
+ * \param name the name of the application attribute to set
+ * \param value the value of the application attribute to set
+ */
+ void SetAttribute (std::string name, const AttributeValue &value);
+
+ /**
+ * Install an ns3::PacketSinkApplication on each node of the input container
+ * configured with all the attributes set with SetAttribute.
+ *
+ * \param c NodeContainer of the set of nodes on which a PacketSinkApplication
+ * will be installed.
+ * \returns Container of Ptr to the applications installed.
+ */
+ ApplicationContainer Install (NodeContainer c) const;
+
+ /**
+ * Install an ns3::PacketSinkApplication on each node of the input container
+ * configured with all the attributes set with SetAttribute.
+ *
+ * \param node The node on which a PacketSinkApplication will be installed.
+ * \returns Container of Ptr to the applications installed.
+ */
+ ApplicationContainer Install (Ptr<Node> node) const;
+
+ /**
+ * Install an ns3::PacketSinkApplication on each node of the input container
+ * configured with all the attributes set with SetAttribute.
+ *
+ * \param nodeName The name of the node on which a PacketSinkApplication will be installed.
+ * \returns Container of Ptr to the applications installed.
+ */
+ ApplicationContainer Install (std::string nodeName) const;
+
+private:
+ /**
+ * Install an ns3::PacketSink on the node configured with all the
+ * attributes set with SetAttribute.
+ *
+ * \param node The node on which an PacketSink will be installed.
+ * \returns Ptr to the application installed.
+ */
+ Ptr<Application> InstallPriv (Ptr<Node> node) const;
+ ObjectFactory m_factory; //!< Object factory.
+};
+
+} // namespace ns3
+
+#endif /* NIST_PACKET_SINK_HELPER_H */
« no previous file with comments | « src/nist/helper/nist-on-off-helper.cc ('k') | src/nist/helper/nist-packet-sink-helper.cc » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b