ndn-interest.h

/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
/*
 * Copyright (c) 2011 University of California, Los Angeles
 *
 * 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: Ilya Moiseenko <iliamo@cs.ucla.edu>
 *         Alexander Afanasyev <alexander.afanasyev@ucla.edu>
 */

#ifndef _NDN_INTEREST_HEADER_H_
#define _NDN_INTEREST_HEADER_H_

#include "ns3/simple-ref-count.h"
#include "ns3/nstime.h"
#include "ns3/packet.h"
#include "ns3/ptr.h"

#include <ns3/ndnSIM/ndn.cxx/name.h>
#include <ns3/ndnSIM/ndn.cxx/exclude.h>

namespace ns3 {

class Packet;

namespace ndn {

class Interest : public SimpleRefCount<Interest>
{
public:
  Interest (Ptr<Packet> payload = Create<Packet> ());

  Interest (const Interest &interest);

  void
  SetName (Ptr<Name> name);

  void
  SetName (const Name &name);
  
  const Name&
  GetName () const;

  Ptr<const Name>
  GetNamePtr () const;

  void
  SetScope (int8_t scope);

  int8_t
  GetScope () const;

  void
  SetInterestLifetime (Time time);

  Time
  GetInterestLifetime () const;

  void
  SetNonce (uint32_t nonce);

  uint32_t
  GetNonce () const;
  
  enum
    {
      NORMAL_INTEREST = 0,
      NACK_LOOP = 10,
      NACK_CONGESTION = 11,
      NACK_GIVEUP_PIT = 12,
    };

  void
  SetNack (uint8_t nackType); //using reserved field
    
  uint8_t
  GetNack () const;

  void
  SetExclude (Ptr<Exclude> exclude);

  Ptr<const Exclude>
  GetExclude () const;
  
  void
  SetPayload (Ptr<Packet> payload);

  Ptr<const Packet>
  GetPayload () const;
  
  inline Ptr<const Packet>
  GetWire () const;

  inline void
  SetWire (Ptr<const Packet> packet) const;

  void
  Print (std::ostream &os) const;
  
private:
  // NO_ASSIGN
  Interest &
  operator = (const Interest &other) { return *this; }
  
private:
  Ptr<Name> m_name;         
  uint8_t m_scope;          
  Time  m_interestLifetime; 
  uint32_t m_nonce;         
  uint8_t  m_nackType;      

  Ptr<Exclude> m_exclude;   
  Ptr<Packet> m_payload;    

  mutable Ptr<const Packet> m_wire;
};

inline std::ostream &
operator << (std::ostream &os, const Interest &i)
{
  i.Print (os);
  return os;
}

inline Ptr<const Packet>
Interest::GetWire () const
{
  return m_wire;
}

inline void
Interest::SetWire (Ptr<const Packet> packet) const
{
  m_wire = packet;
}

class InterestException {};

} // namespace ndn
} // namespace ns3

#endif // _NDN_INTEREST_HEADER_H_