lora-network-controller-components.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2017 University of Padova
 *
 * 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: Davide Magrin <magrinda@dei.unipd.it>
 *
 * Modified by: Bastien Tauran <bastien.tauran@viveris.fr>s
 */
 
#ifndef LORA_NETWORK_CONTROLLER_COMPONENTS_H
#define LORA_NETWORK_CONTROLLER_COMPONENTS_H
 
#include "lora-network-status.h"
 
#include "ns3/log.h"
#include "ns3/object.h"
#include "ns3/packet.h"
 
namespace ns3
{
 
class LoraNetworkStatus;

// Base class //

class LoraNetworkControllerComponent : public Object
{
  public:
    static TypeId GetTypeId(void);
 
    // Constructor and destructor
    LoraNetworkControllerComponent();
    virtual ~LoraNetworkControllerComponent();
 
    // Virtual methods whose implementation is left to child classes
    virtual void OnReceivedPacket(Ptr<const Packet> packet,
                                  Ptr<LoraEndDeviceStatus> status,
                                  Ptr<LoraNetworkStatus> networkStatus) = 0;
 
    virtual void BeforeSendingReply(Ptr<LoraEndDeviceStatus> status,
                                    Ptr<LoraNetworkStatus> networkStatus) = 0;

    virtual void OnFailedReply(Ptr<LoraEndDeviceStatus> status,
                               Ptr<LoraNetworkStatus> networkStatus) = 0;
};

// Acknowledgment management //
 
class LoraConfirmedMessagesComponent : public LoraNetworkControllerComponent
{
  public:
    static TypeId GetTypeId(void);
 
    // Constructor and destructor
    LoraConfirmedMessagesComponent();
    virtual ~LoraConfirmedMessagesComponent();

    void OnReceivedPacket(Ptr<const Packet> packet,
                          Ptr<LoraEndDeviceStatus> status,
                          Ptr<LoraNetworkStatus> networkStatus);
 
    void BeforeSendingReply(Ptr<LoraEndDeviceStatus> status, Ptr<LoraNetworkStatus> networkStatus);
 
    void OnFailedReply(Ptr<LoraEndDeviceStatus> status, Ptr<LoraNetworkStatus> networkStatus);
};

// LinkCheck commands management //
 
class LoraLinkCheckComponent : public LoraNetworkControllerComponent
{
  public:
    static TypeId GetTypeId(void);
 
    // Constructor and destructor
    LoraLinkCheckComponent();
    virtual ~LoraLinkCheckComponent();

    void OnReceivedPacket(Ptr<const Packet> packet,
                          Ptr<LoraEndDeviceStatus> status,
                          Ptr<LoraNetworkStatus> networkStatus);
 
    void BeforeSendingReply(Ptr<LoraEndDeviceStatus> status, Ptr<LoraNetworkStatus> networkStatus);
 
    void OnFailedReply(Ptr<LoraEndDeviceStatus> status, Ptr<LoraNetworkStatus> networkStatus);
 
  private:
    void UpdateLinkCheckAns(Ptr<const Packet> packet, Ptr<LoraEndDeviceStatus> status);
};
 
} // namespace ns3
#endif