satellite-generic-stream-encapsulator-arq.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_GENERIC_STREAM_ENCAPSULATOR_ARQ
#define SATELLITE_GENERIC_STREAM_ENCAPSULATOR_ARQ
 
#include "satellite-arq-buffer-context.h"
#include "satellite-arq-sequence-number.h"
#include "satellite-control-message.h"
#include "satellite-generic-stream-encapsulator.h"
 
#include "ns3/event-id.h"
#include "ns3/mac48-address.h"
 
#include <map>
#include <stdint.h>
 
namespace ns3
{

class SatGenericStreamEncapsulatorArq : public SatGenericStreamEncapsulator
{
  public:
    SatGenericStreamEncapsulatorArq();

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

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatGenericStreamEncapsulatorArq();

    static TypeId GetTypeId(void);

    virtual void DoDispose();

    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;
 
  private:
    void ArqReTxTimerExpired(uint8_t seqNo);

    void CleanUp(uint8_t sequenceNumber);

    uint32_t ConvertSeqNo(uint8_t seqNo) const;

    void ReassembleAndReceive();

    void RxWaitingTimerExpired(uint32_t sn);

    void SendAck(uint8_t seqNo) const;

    Ptr<SatArqSequenceNumber> m_seqNo;

    std::map<uint8_t, Ptr<SatArqBufferContext>> m_txedBuffer; // Transmitted packets buffer
    std::map<uint8_t, Ptr<SatArqBufferContext>> m_retxBuffer; // Retransmission buffer
    uint32_t m_retxBufferSize;
    uint32_t m_txedBufferSize;

    uint32_t m_maxNoOfRetransmissions;

    Time m_retransmissionTimer;

    uint32_t m_arqWindowSize;

    uint32_t m_arqHeaderSize;

    uint32_t m_nextExpectedSeqNo;

    Time m_rxWaitingTimer;

    std::map<uint32_t, Ptr<SatArqBufferContext>> m_reorderingBuffer;
};
 
} // namespace ns3
 
#endif // SATELLITE_GENERIC_STREAM_ENCAPSULATOR_ARQ