epc-ue-nas.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * 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: Nicola Baldo <nbaldo@cttc.es>
 */
 
#ifndef EPC_UE_NAS_H
#define EPC_UE_NAS_H
 
#include "epc-tft-classifier.h"
#include "eps-bearer.h"
#include "lte-as-sap.h"
 
#include <ns3/object.h>
#include <ns3/traced-callback.h>
 
namespace ns3
{
 
class EpcHelper;
class NetDevice;
 
class EpcUeNas : public Object
{
    friend class MemberLteAsSapUser<EpcUeNas>;
 
  public:
    EpcUeNas();
 
    ~EpcUeNas() override;
 
    // inherited from Object
    void DoDispose() override;
    static TypeId GetTypeId();
 
    void SetDevice(Ptr<NetDevice> dev);
 
    void SetImsi(uint64_t imsi);
 
    void SetCsgId(uint32_t csgId);
 
    uint32_t GetCsgId() const;
 
    void SetAsSapProvider(LteAsSapProvider* s);
 
    LteAsSapUser* GetAsSapUser();
 
    void SetForwardUpCallback(Callback<void, Ptr<Packet>> cb);
 
    void StartCellSelection(uint32_t dlEarfcn);
 
    void Connect();
 
    void Connect(uint16_t cellId, uint32_t dlEarfcn);
 
    void Disconnect();
 
    void ActivateEpsBearer(EpsBearer bearer, Ptr<EpcTft> tft);
 
    bool Send(Ptr<Packet> p, uint16_t protocolNumber);
 
    enum State
    {
        OFF = 0,
        ATTACHING,
        IDLE_REGISTERED,
        CONNECTING_TO_EPC,
        ACTIVE,
        NUM_STATES
    };
 
    State GetState() const;
 
    typedef void (*StateTracedCallback)(const State oldState, const State newState);
 
  private:
    // LTE AS SAP methods
    void DoNotifyConnectionSuccessful();
    void DoNotifyConnectionFailed();
    void DoNotifyConnectionReleased();
    void DoRecvData(Ptr<Packet> packet);
 
    // internal methods
    void DoActivateEpsBearer(EpsBearer bearer, Ptr<EpcTft> tft);
    void SwitchToState(State s);
 
    State m_state;
 
    TracedCallback<State, State> m_stateTransitionCallback;
 
    Ptr<NetDevice> m_device;
 
    uint64_t m_imsi;
 
    uint32_t m_csgId;
 
    LteAsSapProvider* m_asSapProvider;
    LteAsSapUser* m_asSapUser;
 
    uint8_t m_bidCounter;             
    EpcTftClassifier m_tftClassifier; 
 
    Callback<void, Ptr<Packet>> m_forwardUpCallback; 
 
    struct BearerToBeActivated
    {
        EpsBearer bearer; 
        Ptr<EpcTft> tft;  
    };
 
    std::list<BearerToBeActivated> m_bearersToBeActivatedList; 
 
    std::list<BearerToBeActivated> m_bearersToBeActivatedListForReconnection;
};
 
} // namespace ns3
 
#endif // EPC_UE_NAS_H