// -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*-
//
// Copyright (c) 2006 Georgia Tech Research Corporation
// All rights reserved.
//
// 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: George F. Riley<riley@ece.gatech.edu>
//

// NS3 - Layer 3 Protocol base class
// George F. Riley, Georgia Tech, Spring 2007

#ifndef L3_PROTOCOL_H
#define L3_PROTOCOL_H

#include "ns3/object.h"
#include "ns3/ptr.h"

namespace ns3 {

class Packet;
class NetDevice;
class TraceResolver;
class TraceContext;

/**
 * ::Send is always defined in subclasses.
 */
class L3Protocol : public Object {
public:
  L3Protocol(int protocolNumber, int version);
  virtual ~L3Protocol ();
  /**
   * \return The protocol number of this Layer 3 protocol
   */  
  int GetProtocolNumber (void) const;
  /**
   * \return The version number of this protocol
   */
  int GetVersion() const;

  virtual TraceResolver *CreateTraceResolver (TraceContext const &context) = 0;
  /**
   * Lower layer calls this method after calling L3Demux::Lookup
   * The ARP subclass needs to know from which NetDevice this
   * packet is coming to:
   *    - implement a per-NetDevice ARP cache
   *    - send back arp replies on the right device
   */
  virtual void Receive(Packet& p, Ptr<NetDevice> device) = 0;

protected:
  virtual void DoDispose (void);
private:
  int m_protocolNumber;
  int m_version;
};

} // Namespace ns3

#endif