ss-link-manager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2007,2008,2009 INRIA, UDcast
 *
 * 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
 *
 * Authors: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
 *          Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
 *                               <amine.ismail@UDcast.com>
 */
 
#ifndef LINK_MANAGER_H
#define LINK_MANAGER_H
 
#include "cid.h"
#include "mac-messages.h"
#include "ss-net-device.h"
#include "wimax-net-device.h"
 
#include "ns3/event-id.h"
#include "ns3/nstime.h"
 
#include <stdint.h>
 
namespace ns3
{
 
class SSLinkManager : public Object
{
  public:
    static TypeId GetTypeId();
    SSLinkManager(Ptr<SubscriberStationNetDevice> ss);
    ~SSLinkManager() override;
    void DoDispose() override;
 
    void SetBsEirp(uint16_t bs_eirp);
    void SetEirXPIrMax(uint16_t eir_x_p_ir_max);
    void SetRangingIntervalFound(bool rangingIntervalFound);
    bool GetRangingIntervalFound() const;
    void SetNrRangingTransOpps(uint8_t nrRangingTransOpps);
    void SetRangingCW(uint8_t rangingCW);
    void IncrementNrInvitedPollsRecvd();
    EventId GetDlMapSyncTimeoutEvent();
 
    void PerformRanging(Cid cid, RngRsp rngrsp);
    void StartScanning(SubscriberStationNetDevice::EventType type, bool deleteParameters);
    void SendRangingRequest(uint8_t uiuc, uint16_t allocationSize);
    void StartContentionResolution();
    void PerformBackoff();
    bool IsUlChannelUsable();
    void ScheduleScanningRestart(Time interval,
                                 SubscriberStationNetDevice::EventType eventType,
                                 bool deleteUlParameters,
                                 EventId& eventId);
 
  private:
    SSLinkManager(const SSLinkManager&);
    SSLinkManager& operator=(const SSLinkManager&);
 
    void EndScanning(bool status, uint64_t frequency);
    void StartSynchronizing();
    bool SearchForDlChannel(uint8_t channel);
    void SelectRandomBackoff();
    void IncreaseRangingRequestCW();
    void ResetRangingRequestCW();
    void DeleteUplinkParameters();
    void AdjustRangingParameters(const RngRsp& rngrsp);
    void NegotiateBasicCapabilities();
    uint16_t CalculateMaxIRSignalStrength();
    uint16_t GetMinTransmitPowerLevel();
 
    Ptr<SubscriberStationNetDevice> m_ss; 
 
    WimaxNetDevice::RangingStatus m_rangingStatus; 
    // initial ranging parameters obtained from DCD (in channel encodings)
    uint16_t m_bsEirp;     
    uint16_t m_eirXPIrMax; 
    uint16_t m_pTxIrMax; 
 
    uint8_t m_initRangOppNumber; 
    uint8_t m_contentionRangingRetries; 
    uint32_t m_rngReqFrameNumber;       
    RngReq m_rngreq;                    
 
    uint8_t m_dlChnlNr;   
    uint64_t m_frequency; 
    bool m_rangingIntervalFound; 
 
    // stats members
    uint16_t m_nrRngReqsSent;       
    uint16_t m_nrRngRspsRecvd;      
    uint16_t m_nrInvitedPollsRecvd; 
 
    uint8_t m_rangingCW;          
    uint8_t m_rangingBO;          
    uint8_t m_nrRangingTransOpps; 
    bool m_isBackoffSet;          
    uint8_t m_rangingAnomalies;   
 
    EventId m_waitForRngRspEvent;    
    EventId m_dlMapSyncTimeoutEvent; 
};
 
} // namespace ns3
 
#endif /* LINK_MANAGER_H */