satellite-return-link-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 SATELLITE_RETURN_LINK_ENCAPSULATOR
#define SATELLITE_RETURN_LINK_ENCAPSULATOR
 
#include "satellite-base-encapsulator.h"
#include "satellite-control-message.h"
 
#include "ns3/event-id.h"
#include "ns3/mac48-address.h"
 
#include <map>
#include <stdint.h>
 
namespace ns3
{

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

    SatReturnLinkEncapsulator(Mac48Address encapAddress,
                              Mac48Address decapAddress,
                              Mac48Address sourceE2EAddress,
                              Mac48Address destE2EAddress,
                              uint8_t rcIndex,
                              uint32_t additionalHeaderSize = 0);

    virtual ~SatReturnLinkEncapsulator();

    static TypeId GetTypeId(void);

    virtual void DoDispose();

    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 GetMinTxOpportunityInBytes() const;
 
  protected:
    Ptr<Packet> GetNewRlePdu(uint32_t txOpportunityBytes,
                             uint32_t maxRlePduSize,
                             uint32_t additionalHeaderSize = 0);

    virtual void ProcessPdu(Ptr<Packet> p);

    void IncreaseFragmentId();

    void Reset();

    uint32_t m_txFragmentId;
    uint32_t m_currRxFragmentId;

    Ptr<Packet> m_currRxPacketFragment;

    uint32_t m_currRxPacketSize;

    uint32_t m_currRxPacketFragmentBytes;

    uint32_t m_minTxOpportunity;

    const uint32_t MAX_FRAGMENT_ID;

    const uint32_t MAX_PPDU_PACKET_SIZE;

    const uint32_t MAX_HL_PDU_PACKET_SIZE;
};
 
} // namespace ns3
 
#endif // SATELLITE_RETURN_LINK_ENCAPSULATOR