satellite-orbiter-net-device.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd.
 *
 * 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: Sami Rantanen <sami.rantanen@magister.fi>
 */
 
#ifndef SATELLITE_ORBITER_NET_DEVICE_H
#define SATELLITE_ORBITER_NET_DEVICE_H
 
#include "satellite-channel.h"
#include "satellite-isl-arbiter.h"
#include "satellite-mac.h"
#include "satellite-phy.h"
#include "satellite-point-to-point-isl-net-device.h"
#include "satellite-signal-parameters.h"
 
#include "ns3/error-model.h"
#include "ns3/mac48-address.h"
#include "ns3/net-device.h"
#include "ns3/output-stream-wrapper.h"
#include "ns3/traced-callback.h"
 
#include <map>
#include <set>
#include <stdint.h>
#include <string>
#include <vector>
 
namespace ns3
{
 
class PointToPointIslNetDevice;
class SatIslArbiter;

class SatOrbiterNetDevice : public NetDevice
{
  public:
    static TypeId GetTypeId(void);

    SatOrbiterNetDevice();

    virtual void ReceivePacketUser(Ptr<Packet> packet, const Address& userAddress) = 0;

    virtual void ReceivePacketFeeder(Ptr<Packet> packet, const Address& feederAddress) = 0;

    void ReceiveUser(SatPhy::PacketContainer_t packets, Ptr<SatSignalParameters> rxParams);

    void ReceiveFeeder(SatPhy::PacketContainer_t packets, Ptr<SatSignalParameters> rxParams);

    virtual bool SendControlMsgToFeeder(Ptr<SatControlMessage> msg,
                                        const Address& dest,
                                        Ptr<SatSignalParameters> rxParams) = 0;

    void AddUserPhy(Ptr<SatPhy> phy, uint32_t beamId);

    void AddFeederPhy(Ptr<SatPhy> phy, uint32_t beamId);

    Ptr<SatPhy> GetUserPhy(uint32_t beamId);

    Ptr<SatPhy> GetFeederPhy(uint32_t beamId);

    std::map<uint32_t, Ptr<SatPhy>> GetUserPhy();

    std::map<uint32_t, Ptr<SatPhy>> GetFeederPhy();

    void AddUserMac(Ptr<SatMac> mac, uint32_t beamId);

    void AddFeederMac(Ptr<SatMac> mac, Ptr<SatMac> macUsed, uint32_t beamId);

    Ptr<SatMac> GetUserMac(uint32_t beamId);

    Ptr<SatMac> GetFeederMac(uint32_t beamId);

    std::map<uint32_t, Ptr<SatMac>> GetUserMac();

    std::map<uint32_t, Ptr<SatMac>> GetFeederMac();

    std::map<uint32_t, Ptr<SatMac>> GetAllFeederMac();

    void AddFeederPair(uint32_t beamId, Mac48Address satelliteFeederAddress);

    void AddUserPair(uint32_t beamId, Mac48Address satelliteUserAddress);

    Mac48Address GetSatelliteFeederAddress(uint32_t beamId);

    Mac48Address GetSatelliteUserAddress(uint32_t beamId);

    void SetReceiveErrorModel(Ptr<ErrorModel> em);

    void SetForwardLinkRegenerationMode(SatEnums::RegenerationMode_t forwardLinkRegenerationMode);

    void SetReturnLinkRegenerationMode(SatEnums::RegenerationMode_t returnLinkRegenerationMode);
 
    void SetNodeId(uint32_t nodeId);

    void ConnectGw(Mac48Address gwAddress, uint32_t beamId);

    void DisconnectGw(Mac48Address gwAddress, uint32_t beamId);

    std::set<Mac48Address> GetGwConnected();

    virtual void ConnectUt(Mac48Address utAddress, uint32_t beamId) = 0;

    virtual void DisconnectUt(Mac48Address utAddress, uint32_t beamId) = 0;

    std::set<Mac48Address> GetUtConnected();

    void AddIslsNetDevice(Ptr<PointToPointIslNetDevice> islNetDevices);

    std::vector<Ptr<PointToPointIslNetDevice>> GetIslsNetDevices();

    void SetArbiter(Ptr<SatIslArbiter> arbiter);

    Ptr<SatIslArbiter> GetArbiter();

    void SendToIsl(Ptr<Packet> packet, Mac48Address destination);

    virtual void ReceiveFromIsl(Ptr<Packet> packet, Mac48Address destination) = 0;
 
    // inherited from NetDevice base class.
    virtual void SetIfIndex(const uint32_t index);
    virtual uint32_t GetIfIndex(void) const;
    virtual void SetAddress(Address address);
    virtual Address GetAddress(void) const;
    virtual bool SetMtu(const uint16_t mtu);
    virtual uint16_t GetMtu(void) const;
    virtual bool IsLinkUp(void) const;
    virtual void AddLinkChangeCallback(Callback<void> callback);
    virtual bool IsBroadcast(void) const;
    virtual Address GetBroadcast(void) const;
    virtual bool IsMulticast(void) const;
    virtual Address GetMulticast(Ipv4Address multicastGroup) const;
    virtual bool IsPointToPoint(void) const;
    virtual bool IsBridge(void) const;
    virtual bool Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber);
    virtual bool SendFrom(Ptr<Packet> packet,
                          const Address& source,
                          const Address& dest,
                          uint16_t protocolNumber);
    virtual Ptr<Node> GetNode(void) const;
    virtual void SetNode(Ptr<Node> node);
    virtual bool NeedsArp(void) const;
    virtual void SetReceiveCallback(NetDevice::ReceiveCallback cb);
    virtual Address GetMulticast(Ipv6Address addr) const;
 
    virtual void SetPromiscReceiveCallback(PromiscReceiveCallback cb);
    virtual bool SupportsSendFrom(void) const;
 
    virtual Ptr<Channel> GetChannel(void) const;
 
  protected:
    virtual void DoDispose(void);

    Address GetRxUtAddress(Ptr<Packet> packet, SatEnums::SatLinkDir_t ld);
 
    NetDevice::ReceiveCallback m_rxCallback;
    NetDevice::PromiscReceiveCallback m_promiscCallback;
    Ptr<Node> m_node;
    uint16_t m_mtu;
    uint32_t m_ifIndex;
    Mac48Address m_address;
    Ptr<ErrorModel> m_receiveErrorModel;
    std::map<uint32_t, Ptr<SatPhy>> m_userPhy;
    std::map<uint32_t, Ptr<SatPhy>> m_feederPhy;
    std::map<uint32_t, Ptr<SatMac>> m_userMac;
    std::map<uint32_t, Ptr<SatMac>> m_feederMac;
 
    std::map<uint32_t, Ptr<SatMac>> m_allFeederMac;
 
    std::map<uint32_t, Mac48Address> m_addressMapFeeder;
 
    std::map<uint32_t, Mac48Address> m_addressMapUser;
 
    SatEnums::RegenerationMode_t m_forwardLinkRegenerationMode;
    SatEnums::RegenerationMode_t m_returnLinkRegenerationMode;
    uint32_t m_nodeId;
 
    bool m_isStatisticsTagsEnabled;
 
    std::map<Mac48Address, Time> m_lastDelays;

    std::map<Mac48Address, uint32_t> m_gwConnected;

    std::map<Mac48Address, uint32_t> m_utConnected;

    std::vector<Ptr<PointToPointIslNetDevice>> m_islNetDevices;

    Ptr<SatIslArbiter> m_arbiter;

    std::set<uint32_t> m_broadcastReceived;
 
    TracedCallback<Time,
                   SatEnums::SatPacketEvent_t,
                   SatEnums::SatNodeType_t,
                   uint32_t,
                   Mac48Address,
                   SatEnums::SatLogLevel_t,
                   SatEnums::SatLinkDir_t,
                   std::string>
        m_packetTrace;

    TracedCallback<Ptr<const Packet>> m_txTrace;

    TracedCallback<Ptr<const Packet>, const Address&> m_signallingTxTrace;

    TracedCallback<Ptr<const Packet>, const Address&> m_rxFeederTrace;

    TracedCallback<Ptr<const Packet>, const Address&> m_rxUserTrace;

    TracedCallback<const Time&, const Address&> m_rxFeederLinkDelayTrace;

    TracedCallback<const Time&, const Address&> m_rxFeederLinkJitterTrace;

    TracedCallback<const Time&, const Address&> m_rxUserLinkDelayTrace;

    TracedCallback<const Time&, const Address&> m_rxUserLinkJitterTrace;
};
 
} // namespace ns3
 
#endif /* SATELLITE_ORBITER_NET_DEVICE_H */