satellite-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: Jani Puttonen <jani.puttonen@magister.fi>
 */
 
#ifndef SATELLITE_NET_DEVICE_H
#define SATELLITE_NET_DEVICE_H
 
#include "satellite-enums.h"
#include "satellite-packet-classifier.h"
 
#include "ns3/mac48-address.h"
#include "ns3/net-device.h"
#include "ns3/nstime.h"
#include "ns3/simulator.h"
#include "ns3/traced-callback.h"
 
#include <stdint.h>
#include <string>
 
namespace ns3
{
 
class SatPhy;
class SatMac;
class SatLlc;
class Node;
class ErrorModel;
class SatNodeInfo;
class SatControlMessage;

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

    SatNetDevice();
 
    /*
     * @brief Receive the packet from mac layer
     * @param packet Pointer to the packet to be received.
     */
    virtual void Receive(Ptr<const Packet> packet);
 
    /*
     * @brief Attach the SatPhy physical layer to this netdevice.
     * @param phy SatPhy pointer to be added
     */
    void SetPhy(Ptr<SatPhy> phy);

    Ptr<SatPhy> GetPhy(void) const;
 
    /*
     * @brief Attach the SatMac mac layer to this netdevice.
     * @param mac SatMac pointer to be added
     */
    void SetMac(Ptr<SatMac> mac);

    Ptr<SatMac> GetMac(void) const;

    void SetLlc(Ptr<SatLlc> llc);

    Ptr<SatLlc> GetLlc(void) const;

    void SetPacketClassifier(Ptr<SatPacketClassifier> classifier);

    Ptr<SatPacketClassifier> GetPacketClassifier() const;

    void SetReceiveErrorModel(Ptr<ErrorModel> em);
 
    // 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);
    bool SendControlMsg(Ptr<SatControlMessage> msg, const Address& dest);
    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;

    void SetNodeInfo(Ptr<SatNodeInfo> nodeInfo);

    void ToggleState(bool enabled);
 
  protected:
    virtual void DoDispose(void);
 
    Ptr<SatPhy> m_phy;
    Ptr<SatMac> m_mac;
    Ptr<SatLlc> m_llc;
    bool m_isStatisticsTagsEnabled; 
    Ptr<SatPacketClassifier> m_classifier;
    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;
 
    Ptr<SatNodeInfo> m_nodeInfo;

    Time m_lastDelay;

    Time m_lastLinkDelay;
 
    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_rxTrace;

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

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

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

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