satellite-orbiter-llc.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 *
 * 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_ORBITER_LLC_H
#define SATELLITE_ORBITER_LLC_H
 
#include "satellite-base-encapsulator.h"
#include "satellite-llc.h"
#include "satellite-node-info.h"
 
#include <stdint.h>
#include <vector>
 
namespace ns3
{

class SatOrbiterLlc : public SatLlc
{
  public:
    static TypeId GetTypeId(void);

    SatOrbiterLlc();

    virtual ~SatOrbiterLlc();

    virtual bool Enque(Ptr<Packet> packet, Address dest, uint8_t flowId);

    virtual Ptr<Packet> NotifyTxOpportunity(uint32_t bytes,
                                            Mac48Address utAddr,
                                            uint8_t flowId,
                                            uint32_t& bytesLeft,
                                            uint32_t& nextMinTxO);

    virtual void ReceiveHigherLayerPdu(Ptr<Packet> packet, Mac48Address source, Mac48Address dest);

    virtual void GetSchedulingContexts(std::vector<Ptr<SatSchedulingObject>>& output) const;

    virtual uint32_t GetNBytesInQueue(Mac48Address utAddress) const;

    virtual uint32_t GetNPacketsInQueue(Mac48Address utAddress) const;

    virtual void ClearQueues();

    typedef Callback<void, Ptr<Packet>, const Address&> ReceiveSatelliteCallback;

    void SetReceiveSatelliteCallback(SatOrbiterLlc::ReceiveSatelliteCallback cb);
 
  protected:
    virtual void DoDispose();

    virtual void CreateEncap(Ptr<EncapKey> key);

    virtual void CreateDecap(Ptr<EncapKey> key);

    ReceiveSatelliteCallback m_rxSatelliteCallback;
};
 
} // namespace ns3
 
#endif /* SATELLITE_ORBITER_LLC_H */