satellite-isl-arbiter.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
 *
 * Inspired and adapted from Hypatia: https://github.com/snkas/hypatia
 *
 * Author: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef SATELLITE_ISL_ARBITER_H
#define SATELLITE_ISL_ARBITER_H
 
#include "satellite-orbiter-net-device.h"
 
#include "ns3/mac48-address.h"
#include "ns3/node.h"
#include "ns3/packet.h"
 
#include <stdint.h>
#include <string>
 
namespace ns3
{
 
class SatIslArbiter : public Object
{
  public:
    static TypeId GetTypeId(void);

    SatIslArbiter();

    SatIslArbiter(Ptr<Node> node);

    int32_t BaseDecide(Ptr<Packet> pkt, Mac48Address destination);

    virtual int32_t Decide(int32_t sourceSatId, int32_t targetSatId, Ptr<Packet> pkt) = 0;

    virtual std::string StringReprOfForwardingState() = 0;
 
  protected:
    uint32_t m_nodeId; // ID of node where this arbiter is installed.
};
 
} // namespace ns3
 
#endif // SATELLITE_ISL_ARBITER_H