csma-star-helper.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: GPL-2.0-only
 */
 
// Define an object to create a star topology.
 
#ifndef CSMA_STAR_HELPER_H
#define CSMA_STAR_HELPER_H
 
#include "ns3/csma-helper.h"
#include "ns3/internet-stack-helper.h"
#include "ns3/ipv4-address-helper.h"
#include "ns3/ipv4-interface-container.h"
#include "ns3/ipv6-address-generator.h"
#include "ns3/ipv6-address-helper.h"
#include "ns3/ipv6-interface-container.h"
 
#include <string>
 
namespace ns3
{
 
/**
 * \defgroup csmalayout CSMA Layout Helpers
 *
 */
 
/**
 * \ingroup csmalayout
 *
 * \brief A helper to make it easier to create a star topology
 * with Csma links
 */
class CsmaStarHelper
{
  public:
    /**
     * Create a CsmaStarHelper in order to easily create
     * star topologies using Csma links
     *
     * \param numSpokes the number of links attached to
     *        the hub node, creating a total of
     *        numSpokes + 1 nodes
     *
     * \param csmaHelper the link helper for Csma links,
     *        used to link nodes together
     */
    CsmaStarHelper(uint32_t numSpokes, CsmaHelper csmaHelper);
 
    ~CsmaStarHelper();
 
  public:
    /**
     * \returns a node pointer to the hub node in the
     *          star, i.e., the center node
     */
    Ptr<Node> GetHub() const;
 
    /**
     * \param i an index into the spokes of the star
     *
     * \returns a node pointer to the node at the indexed spoke
     */
    Ptr<Node> GetSpokeNode(uint32_t i) const;
 
    /**
     * \returns the net-device container which contains all of
     *          the devices on the hub node
     */
    NetDeviceContainer GetHubDevices() const;
 
    /**
     * \returns the net-device container which contains all of
     *          the spoke node devices
     */
    NetDeviceContainer GetSpokeDevices() const;
 
    /**
     * \param i index into the hub interfaces
     *
     * \returns Ipv4Address according to indexed hub interface
     */
    Ipv4Address GetHubIpv4Address(uint32_t i) const;
 
    /**
     * \param i index into the hub interfaces
     *
     * \returns Ipv6Address according to indexed hub interface
     */
    Ipv6Address GetHubIpv6Address(uint32_t i) const;
 
    /**
     * \param i index into the spoke interfaces
     *
     * \returns Ipv4Address according to indexed spoke interface
     */
    Ipv4Address GetSpokeIpv4Address(uint32_t i) const;
 
    /**
     * \param i index into the spoke interfaces
     *
     * \returns Ipv6Address according to indexed spoke interface
     */
    Ipv6Address GetSpokeIpv6Address(uint32_t i) const;
 
    /**
     * \returns the total number of spokes in the star
     */
    uint32_t SpokeCount() const;
 
    /**
     * \param stack an InternetStackHelper which is used to install
     *              on every node in the star
     */
    void InstallStack(InternetStackHelper stack);
 
    /**
     * \param address an Ipv4AddressHelper which is used to install
     *                Ipv4 addresses on all the node interfaces in
     *                the star
     */
    void AssignIpv4Addresses(Ipv4AddressHelper address);
 
    /**
     * \param network an IPv6 Address representing the network portion
     *                of the Ipv6 Address
     * \param prefix the prefix length
     */
    void AssignIpv6Addresses(Ipv6Address network, Ipv6Prefix prefix);
 
  private:
    NodeContainer m_hub;                    //!< NodeContainer for the hub node
    NetDeviceContainer m_hubDevices;        //!< NetDeviceContainer for the hub node NetDevices
    NodeContainer m_spokes;                 //!< NodeContainer for the spokes nodes
    NetDeviceContainer m_spokeDevices;      //!< NetDeviceContainer for the spokes nodes NetDevices
    Ipv4InterfaceContainer m_hubInterfaces; //!< Ipv4InterfaceContainer for the hub IPv4 interfaces
    Ipv4InterfaceContainer
        m_spokeInterfaces; //!< Ipv4InterfaceContainer for the spokes IPv4 interfaces
    Ipv6InterfaceContainer m_hubInterfaces6; //!< Ipv6InterfaceContainer for the hub IPv6 interfaces
    Ipv6InterfaceContainer
        m_spokeInterfaces6; //!< Ipv6InterfaceContainer for the spokes IPv6 interfaces
};
 
} // namespace ns3
 
#endif /* CSMA_STAR_HELPER_H */