doxygen OnOffHelper.

This commit is contained in:
Mathieu Lacage
2008-08-26 11:17:31 -07:00
parent dab7ef6871
commit 8027faacca

View File

@@ -31,13 +31,34 @@
namespace ns3 {
/**
* \brief instanciate an ns3::OnOffApplication on a set of nodes.
*/
class OnOffHelper
{
public:
/**
* \param protocol the name of the protocol to use to send traffic
* by the applications. This string identifies the socket
* factory type used to create sockets for the applications.
* A typical value would be ns3::UdpSocketFactory.
* \param address the address of the remote node to send traffic
* to.
*/
OnOffHelper (std::string protocol, Address address);
/**
* \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);
/**
* \param c the set of nodes on which an OnOffApplication will be installed.
*
* Install an ns3::OnOffApplication on each node of the input container
* configured with all the attributes set with SetAttribute.
*/
ApplicationContainer Install (NodeContainer c);
private: