pending-data.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
//
// Copyright (c) 2006 Georgia Tech Research Corporation
//
// 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: Rajib Bhattacharjea<raj.b@gatech.edu>
//

// Georgia Tech Network Simulator - Data Descriptors
// George F. Riley.  Georgia Tech, Spring 2002

#ifndef PENDING_DATA_H
#define PENDING_DATA_H

#include "ns3/packet.h"
#include "pending-data.h"
#include "ns3/sequence-number.h"

#include "ns3/ptr.h"
namespace ns3
{
class Packet;

class PendingData {
public:
  PendingData ();
  PendingData (uint32_t s, uint8_t* d = NULL, uint32_t msg = 0, uint32_t resp = 0);
  PendingData (const std::string& s); // Construct from string

  PendingData (const PendingData& o);   // Copy constructor
  virtual ~PendingData ();     // Destructor

  uint32_t Size () const { return size; }

  virtual void Clear ();

  virtual void Add (uint32_t s, const uint8_t* d = 0); //
  virtual void Add (Ptr<Packet> p);
  virtual uint32_t SizeFromSeq (const SequenceNumber32& seqFront, const SequenceNumber32& seqOffset);
  // Inquire available data from offset
  virtual uint32_t SizeFromOffset (uint32_t offset);
  // Available size from sequence difference 
  virtual uint32_t OffsetFromSeq (const SequenceNumber32& seqFront, const SequenceNumber32& seqOffset);

  virtual Ptr<Packet> CopyFromOffset  (uint32_t s, uint32_t o);  // Size, offset, ret packet
  virtual Ptr<Packet> CopyFromSeq (uint32_t s, const SequenceNumber32& f, const SequenceNumber32& o);
  virtual uint32_t RemoveToSeq (const SequenceNumber32& seqFront, const SequenceNumber32& seqOffset);

  PendingData*   Copy () const;
  PendingData*   CopyS (uint32_t s);         // Copy
  PendingData*   CopySD (uint32_t s, uint8_t* d);
public:
  uint32_t size;        
  std::vector<Ptr<Packet> > data;         
  // The next two fields allow simulated applications to exchange some info
  uint32_t msgSize;     
  uint32_t responseSize; 
};

} //namespace ns3

#endif /* PENDING_DATA_H */