1.1 --- a/src/helper/udp-echo-helper.h	Thu Oct 01 11:16:04 2009 +0200
     1.2 +++ b/src/helper/udp-echo-helper.h	Thu Oct 01 11:22:26 2009 +0200
     1.3 @@ -28,15 +28,49 @@
     1.4  
     1.5  namespace ns3 {
     1.6  
     1.7 +/**
     1.8 + * \brief create a server application which waits for input udp packets
     1.9 + *        and sends them back to the original sender.
    1.10 + */
    1.11  class UdpEchoServerHelper
    1.12  {
    1.13  public:
    1.14 +  /**
    1.15 +   * \param port the port the server will wait on for incoming packets
    1.16 +   */
    1.17    UdpEchoServerHelper (uint16_t port);
    1.18  
    1.19 +  /**
    1.20 +   * \param name the name of the attribute to set
    1.21 +   * \param value the value of the attribute to set
    1.22 +   *
    1.23 +   * Record an attribute to be set after the server application is created.
    1.24 +   */
    1.25    void SetAttribute (std::string name, const AttributeValue &value);
    1.26  
    1.27 +  /**
    1.28 +   * \param node the node
    1.29 +   *
    1.30 +   * Create a udp echo server application on the input node
    1.31 +   *
    1.32 +   * \returns the application created
    1.33 +   */
    1.34    ApplicationContainer Install (Ptr<Node> node) const;
    1.35 +  /**
    1.36 +   * \param nodeName the node
    1.37 +   *
    1.38 +   * Create a udp echo server application on the input node
    1.39 +   *
    1.40 +   * \returns the application created
    1.41 +   */
    1.42    ApplicationContainer Install (std::string nodeName) const;
    1.43 +  /**
    1.44 +   * \param c the nodes
    1.45 +   *
    1.46 +   * Create one udp echo server application on each of the input nodes
    1.47 +   *
    1.48 +   * \returns the applications created, one application per input node.
    1.49 +   */
    1.50    ApplicationContainer Install (NodeContainer c) const;
    1.51  
    1.52  private:
    1.53 @@ -45,11 +79,24 @@
    1.54    ObjectFactory m_factory;
    1.55  };
    1.56  
    1.57 +/**
    1.58 + * \brief create an application which sends a udp packet and waits for an echo of this packet
    1.59 + */
    1.60  class UdpEchoClientHelper
    1.61  {
    1.62  public:
    1.63 +  /**
    1.64 +   * \param ip ip address of the remote udp echo server
    1.65 +   * \param port port number of the remote udp echo server
    1.66 +   */
    1.67    UdpEchoClientHelper (Ipv4Address ip, uint16_t port);
    1.68  
    1.69 +  /**
    1.70 +   * \param name the name of the attribute to set
    1.71 +   * \param value the value of the attribute to set
    1.72 +   *
    1.73 +   * Record an attribute to be set after the client application is created.
    1.74 +   */
    1.75    void SetAttribute (std::string name, const AttributeValue &value);
    1.76  
    1.77    /**
    1.78 @@ -103,8 +150,29 @@
    1.79     */
    1.80    void SetFill (Ptr<Application> app, uint8_t *fill, uint32_t fillLength, uint32_t dataLength);
    1.81  
    1.82 +  /**
    1.83 +   * \param node the node
    1.84 +   *
    1.85 +   * Create a udp echo client application on the input node
    1.86 +   *
    1.87 +   * \returns the application created
    1.88 +   */
    1.89    ApplicationContainer Install (Ptr<Node> node) const;
    1.90 +  /**
    1.91 +   * \param nodeName the node
    1.92 +   *
    1.93 +   * Create a udp echo client application on the input node
    1.94 +   *
    1.95 +   * \returns the application created
    1.96 +   */
    1.97    ApplicationContainer Install (std::string nodeName) const;
    1.98 +  /**
    1.99 +   * \param c the nodes
   1.100 +   *
   1.101 +   * Create one udp echo client application on each of the input nodes
   1.102 +   *
   1.103 +   * \returns the applications created, one application per input node.
   1.104 +   */
   1.105    ApplicationContainer Install (NodeContainer c) const;
   1.106  
   1.107  private: