satellite-point-to-point-isl-net-device.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007, 2008 University of Washington
 *
 * 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
 *
 * (Based on point-to-point network device)
 * Author: Andre Aguas    March 2020
 *         Simon          2020
 * Adapted to SNS-3 by: Bastien Tauran <bastien.tauran@viveris.fr>
 *
 */
 
#ifndef SATELLITE_POINT_TO_POINT_ISL_NET_DEVICE_H
#define SATELLITE_POINT_TO_POINT_ISL_NET_DEVICE_H
 
#include "satellite-orbiter-net-device.h"
 
#include "ns3/address.h"
#include "ns3/callback.h"
#include "ns3/data-rate.h"
#include "ns3/mac48-address.h"
#include "ns3/net-device.h"
#include "ns3/node.h"
#include "ns3/nstime.h"
#include "ns3/packet.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
 
#include <cstring>
#include <stdint.h>
 
namespace ns3
{
 
template <typename Item>
class DropTailQueue;
class PointToPointIslChannel;
class ErrorModel;
class SatOrbiterNetDevice;

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

    PointToPointIslNetDevice();

    virtual ~PointToPointIslNetDevice();

    void SetDataRate(DataRate bps);

    void SetInterframeGap(Time t);

    bool Attach(Ptr<PointToPointIslChannel> ch);

    void SetQueue(Ptr<DropTailQueue<Packet>> queue);

    Ptr<DropTailQueue<Packet>> GetQueue(void) const;

    void SetReceiveErrorModel(Ptr<ErrorModel> em);

    void Receive(Ptr<Packet> p);

    void SetOrbiterNetDevice(Ptr<SatOrbiterNetDevice> orbiterNetDevice);
 
    // The remaining methods are documented in ns3::NetDevice*
 
    virtual void SetIfIndex(const uint32_t index);
    virtual uint32_t GetIfIndex(void) const;
 
    virtual Ptr<Channel> GetChannel(void) const;
 
    virtual void SetAddress(Address address);
    virtual Address GetAddress(void) const;
 
    virtual void SetDestinationNode(Ptr<Node> node);
    virtual Ptr<Node> GetDestinationNode(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;
 
  private:
    PointToPointIslNetDevice& operator=(const PointToPointIslNetDevice& o);

    PointToPointIslNetDevice(const PointToPointIslNetDevice& o);

    virtual void DoDispose(void);

    Address GetRemote(void) const;

    void AddHeader(Ptr<Packet> p, uint16_t protocolNumber);

    bool ProcessHeader(Ptr<Packet> p, uint16_t& param);

    bool TransmitStart(Ptr<Packet> p);

    void TransmitComplete(void);

    void NotifyLinkUp(void);

    enum TxMachineState
    {
        READY, 
        BUSY   
    };
 
    static const uint16_t DEFAULT_MTU = 1500; 
 
    TxMachineState m_txMachineState; 
    DataRate m_dataRate; 
    Time m_tInterframeGap; 
    Ptr<PointToPointIslChannel> m_channel; 
    Ptr<DropTailQueue<Packet>>
        m_queue; 
                 //   Management of this Queue has been delegated to the PointToPointIslNetDevice
                 //   and it has the responsibility for deletion
    Ptr<ErrorModel> m_receiveErrorModel;     
    Ptr<Node> m_node;                        
    Ptr<Node> m_destinationNode;             
    Mac48Address m_address;                  
    NetDevice::ReceiveCallback m_rxCallback; 
    NetDevice::PromiscReceiveCallback m_promiscCallback; 
                                                         //   (promisc data)
    uint32_t m_ifIndex;                                  
    bool m_linkUp;                                       
    uint32_t m_mtu;                                      
    Ptr<Packet> m_currentPkt;                            
 
    Ptr<SatOrbiterNetDevice>
        m_orbiterNetDevice; 

    static uint16_t PppToEther(uint16_t protocol);

    static uint16_t EtherToPpp(uint16_t protocol);

    TracedCallback<uint32_t, Ptr<Node>, Ptr<Node>, bool> m_packetDropRateTrace;
};
 
} // namespace ns3
 
#endif /* SATELLITE_POINT_TO_POINT_ISL_NET_DEVICE_H */