// -*- 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>

//

// Define the L3Protocols capability for ns3.

// George F. Riley, Georgia Tech, Fall 2006

// This object manages the different layer 3 protocols for any ns3

// node that has this capability.  

#ifndef L3_DEMUX_H

#define L3_DEMUX_H

#include <map>

namespace ns3 {

class L3Protocol;

class Node;

class TraceResolver;

class TraceContext;

/**

 * \brief L3 Demux 

 */

class L3Demux

{

public:

  typedef int ProtocolTraceType;

  L3Demux(Node *node);

  virtual ~L3Demux();

  /**

   * \param node the node on which the returned copy will run.

   * \returns a deep copy of this L3 Demux.

   */

  L3Demux* Copy(Node *node) const;

  /**

   * \param context the trace context to use to construct the

   *        TraceResolver to return

   * \returns a TraceResolver which can resolve all traces

   *          performed in this object. The caller must

   *          delete the returned object.

   */

  TraceResolver *CreateTraceResolver (TraceContext const &context);

  /**

   * \param protocol a template for the protocol to add to this L3 Demux.

   * \returns the L3Protocol effectively added.

   *

   * Invoke Copy on the input template to get a copy of the input

   * protocol which can be used on the Node on which this L3 Demux 

   * is running. The new L3Protocol is registered internally as

   * a working L3 Protocol and returned from this method.

   * The caller does not get ownership of the returned pointer.

   */

  ns3::L3Protocol* Insert(const ns3::L3Protocol& protocol);

  /**

   * \param protocolNumber number of protocol to lookup

   *        in this L4 Demux

   * \returns a matching L3 Protocol

   *

   * This method is typically called by lower layers

   * to forward packets up the stack to the right protocol.

   * It is also called from InternetNode::GetIpv4 for example.

   */

  /**

   * \param protocol protocol to remove from this demux.

   *

   * The input value to this method should be the value

   * returned from the L3Protocol::Insert method.

   */

  void Erase(ns3::L3Protocol*protocol);

private:

  typedef std::map<int, ns3::L3Protocol*> L3Map_t;

  Node *m_node;

  L3Map_t m_protocols;

};

} //namespace ns3

#endif