satellite-ut-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: Jani Puttonen <jani.puttonen@magister.fi>
 */
 
#ifndef SATELLITE_UT_LLC_H
#define SATELLITE_UT_LLC_H
 
#include "satellite-llc.h"
#include "satellite-queue.h"
 
#include "ns3/ptr.h"
 
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class Packet;
class Address;
class Mac48Address;
class SatRequestManager;
class SatSchedulingObject;
class SatNodeInfo;

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

    SatUtLlc();

    virtual ~SatUtLlc();

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

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

    void SetRequestManager(Ptr<SatRequestManager> rm);

    Ptr<SatRequestManager> GetRequestManager() const;

    void SetQueueStatisticsCallbacks();

    virtual uint32_t GetNumSmallerPackets(uint32_t maxPacketSizeBytes) const;

    virtual void SetNodeInfo(Ptr<SatNodeInfo> nodeInfo);

    virtual uint32_t GetNBytesInQueue(Mac48Address utAddress) const;

    virtual uint32_t GetNPacketsInQueue(Mac48Address utAddress) const;

    void SetMacQueueEventCallback(SatQueue::QueueEventCallback cb);

    void SetGwAddress(Mac48Address address);
 
  protected:
    void DoDispose();

    virtual void CreateEncap(Ptr<EncapKey> key);

    virtual void CreateEncap(Ptr<EncapKey> key, Ptr<SatQueue> providedQueue);

    virtual void CreateDecap(Ptr<EncapKey> key);

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

    virtual SatEnums::SatLinkDir_t GetSatLinkTxDir();

    virtual SatEnums::SatLinkDir_t GetSatLinkRxDir();
 
  private:
    Ptr<SatRequestManager> m_requestManager;

    SatQueue::QueueEventCallback m_macQueueEventCb;
};
 
} // namespace ns3
 
#endif /* SATELLITE_UT_LLC_H */