satellite-base-encapsulator.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 SAT_BASE_ENCAPSULATOR_H
#define SAT_BASE_ENCAPSULATOR_H
 
#include "satellite-control-message.h"
#include "satellite-queue.h"
 
#include "ns3/mac48-address.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/packet.h"
#include "ns3/trace-source-accessor.h"
#include "ns3/traced-value.h"
#include "ns3/uinteger.h"
 
#include <stdint.h>
 
namespace ns3
{

class SatBaseEncapsulator : public Object
{
  public:
    SatBaseEncapsulator();

    SatBaseEncapsulator(Mac48Address encapAddress,
                        Mac48Address decapAddress,
                        Mac48Address sourceE2EAddress,
                        Mac48Address destE2EAddress,
                        uint8_t flowId,
                        uint32_t additionalHeaderSize = 0);

    virtual ~SatBaseEncapsulator();

    static TypeId GetTypeId(void);

    virtual void DoDispose();

    typedef Callback<void, Ptr<Packet>, Mac48Address, Mac48Address> ReceiveCallback;

    typedef Callback<bool, Ptr<SatControlMessage>, const Address&> SendCtrlCallback;

    void SetQueue(Ptr<SatQueue> queue);

    Ptr<SatQueue> GetQueue();

    void SetReceiveCallback(ReceiveCallback cb);

    void SetCtrlMsgCallback(SatBaseEncapsulator::SendCtrlCallback cb);

    virtual void EnquePdu(Ptr<Packet> p, Mac48Address dest);

    virtual Ptr<Packet> NotifyTxOpportunity(uint32_t bytes,
                                            uint32_t& bytesLeft,
                                            uint32_t& nextMinTxO);

    virtual void ReceivePdu(Ptr<Packet> p);

    virtual void ReceiveAck(Ptr<SatArqAckMessage> ack);

    virtual uint32_t GetTxBufferSizeInBytes() const;

    virtual Time GetHolDelay() const;

    virtual uint32_t GetMinTxOpportunityInBytes() const;
 
  protected:
    Mac48Address m_encapAddress;
    Mac48Address m_decapAddress;
    Mac48Address m_sourceE2EAddress;
    Mac48Address m_destE2EAddress;

    uint8_t m_flowId;

    Ptr<SatQueue> m_txQueue;

    uint32_t m_additionalHeaderSize;

    ReceiveCallback m_rxCallback;

    SendCtrlCallback m_ctrlCallback;
};
 
} // namespace ns3
 
#endif // SAT_BASE_ENCAPSULATOR_H