satellite-gw-mac.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 SAT_GW_MAC_H
#define SAT_GW_MAC_H
 
#include "satellite-mac.h"
#include "satellite-phy.h"
 
#include "ns3/callback.h"
#include "ns3/nstime.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
 
#include <map>
#include <set>
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class Packet;
class Address;
class Mac48Address;
class SatBbFrame;
class SatCrMessage;
class SatSignalParameters;
class SatFwdLinkScheduler;

 
class SatGwMac : public SatMac
{
  public:
    static TypeId GetTypeId(void);

    SatGwMac();

    SatGwMac(Ptr<Node> node,
             uint32_t satId,
             uint32_t beamId,
             uint32_t feederSatId,
             uint32_t feederBeamId);

    ~SatGwMac();

    void StartPeriodicTransmissions();

    void Receive(SatPhy::PacketContainer_t packets, Ptr<SatSignalParameters> /*rxParams*/);

    void TbtpSent(Ptr<SatTbtpMessage> tbtp);

    uint32_t GetFeederSatId();

    uint32_t GetFeederBeamId();

    typedef Callback<void, uint32_t, uint32_t, Address, Ptr<SatCrMessage>> CrReceiveCallback;

    void SetCrReceiveCallback(SatGwMac::CrReceiveCallback cb);

    typedef Callback<Ptr<Packet>, uint32_t, Mac48Address, uint32_t&> TxOpportunityCallback;

    void SetTxOpportunityCallback(SatGwMac::TxOpportunityCallback cb);

    typedef Callback<void, Address, uint32_t, uint32_t, uint32_t, uint32_t> HandoverCallback;

    void SetHandoverCallback(SatGwMac::HandoverCallback cb);

    typedef Callback<void, Address, uint32_t, uint32_t, Callback<void, uint32_t>> LogonCallback;

    void SetLogonCallback(SatGwMac::LogonCallback cb);

    typedef Callback<void, uint32_t, uint32_t> PhyBeamCallback;

    void SetBeamCallback(SatGwMac::PhyBeamCallback cb);

    typedef Callback<void, Address, uint32_t, uint32_t> ControlMessageReceivedCallback;

    void SetControlMessageReceivedCallback(SatGwMac::ControlMessageReceivedCallback cb);

    typedef Callback<void, Address, uint32_t, uint32_t> RemoveUtCallback;

    void SetRemoveUtCallback(SatGwMac::RemoveUtCallback cb);

    typedef Callback<void> ClearQueuesCallback;

    void SetClearQueuesCallback(SatGwMac::ClearQueuesCallback cb);

    void SetFwdScheduler(Ptr<SatFwdLinkScheduler> fwdScheduler);

    void ChangeBeam(uint32_t satId, uint32_t beamId);

    void ConnectUt(Mac48Address utAddress);

    void DisconnectUt(Mac48Address utAddress);
 
  private:
    SatGwMac& operator=(const SatGwMac&);
    SatGwMac(const SatGwMac&);
 
    void DoDispose(void);

    void StartTransmission(uint32_t carrierId);

    void StartNcrTransmission();

    void ReceiveSignalingPacket(Ptr<Packet> packet, uint32_t satId, uint32_t beamId);
 
    void SendNcrMessage();

    void RemoveTbtp(uint32_t superframeCounter);
 
    void SendCmtMessage(Address utId,
                        Time burstDuration,
                        Time satelliteReceptionTime,
                        uint32_t satId,
                        uint32_t beamId);
 
    void SendLogonResponse(Address utId, uint32_t raChannel);
    static void SendLogonResponseHelper(SatGwMac* self, Address utId, uint32_t raChannel);

    virtual void StopPeriodicTransmissions();

    bool HasPeer();

    Ptr<Node> m_node;

    uint32_t m_feederSatId;

    uint32_t m_feederBeamId;

    std::map<uint32_t, std::vector<Ptr<SatTbtpMessage>>> m_tbtps;

    Ptr<SatFwdLinkScheduler> m_fwdScheduler;

    Time m_guardTime;

    Time m_ncrInterval;

    bool m_useCmt;

    std::map<Address, Time> m_lastCmtSent;

    Time m_cmtPeriodMin;

    bool m_broadcastNcr;

    bool m_disableSchedulingIfNoDeviceConnected;

    bool m_periodicTransmissionEnabled;

    std::set<Mac48Address> m_peers;

    TracedCallback<Ptr<SatBbFrame>> m_bbFrameTxTrace;

    SatGwMac::CrReceiveCallback m_crReceiveCallback;

    SatGwMac::TxOpportunityCallback m_txOpportunityCallback;

    SatGwMac::HandoverCallback m_handoverCallback;

    SatGwMac::LogonCallback m_logonCallback;

    SatGwMac::PhyBeamCallback m_beamCallback;

    SatGwMac::ControlMessageReceivedCallback m_controlMessageReceivedCallback;

    SatGwMac::RemoveUtCallback m_removeUtCallback;

    SatGwMac::ClearQueuesCallback m_clearQueuesCallback;
};
 
} // namespace ns3
 
#endif /* SAT_GW_MAC_H */