satellite-ut-mac-state.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 * Copyright (c) 2018 CNES
 *
 * 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: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef SATELLITE_UT_MAC_STATE_H
#define SATELLITE_UT_MAC_STATE_H
 
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/simulator.h"
 
namespace ns3
{

class SatUtMacState : public Object
{
  public:
    typedef enum
    {
        HOLD_STANDBY,
        OFF_STANDBY,
        READY_FOR_LOGON,
        READY_FOR_TDMA_SYNC,
        TDMA_SYNC,
        NCR_RECOVERY,
    } RcstState_t;

    static TypeId GetTypeId(void);

    SatUtMacState();

    ~SatUtMacState();

    typedef Callback<void> LogOffCallback;

    void SetLogOffCallback(LogOffCallback cb);

    RcstState_t GetState() const;

    void SwitchToHoldStandby();

    void SwitchToOffStandby();

    void SwitchToReadyForLogon();

    void SwitchToReadyForTdmaSync();

    void SwitchToTdmaSync();

    void SwitchToNcrRecovery();

    void NcrControlMessageReceived();

    bool IsNcrTimeout() const;
 
  private:
    RcstState_t m_rcstState; // Current state
 
    Time m_lastNcrDateReceived;       // Last time a NCR control message was received
    Time m_checkNcrRecoveryScheduled; // Last time state switched to NCR_RECOVERY
 
    Time m_ncrSyncTimeout;     // Timeout to switch from TDMA_SYNC to NCR_RECOVERY
    Time m_ncrRecoveryTimeout; // Timeout to switch from NCR_RECOVERY to OFF_STANDBY
 
    LogOffCallback m_logOffCallback; // Callback to call LogOff of SatUtMac

    void CheckNcrTimeout();

    void CheckNcrRecoveryTimeout();
};
 
} // namespace ns3
 
#endif /* SATELLITE_UT_MAC_STATE_H */