/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2006 Georgia Tech Research Corporation, INRIA

 *

 * 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

 *

 * Authors: George F. Riley<riley@ece.gatech.edu>

 *          Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#ifndef NODE_H

#define NODE_H

#include <vector>

#include "ns3/object.h"

#include "ns3/callback.h"

#include "ns3/trace-context-element.h"

#include "ns3/ptr.h"

namespace ns3 {

class TraceContext;

class TraceResolver;

class NetDevice;

class Application;

class Packet;

class Address;

class CompositeTraceResolver;

/**

 * \brief hold in a TraceContext the index of a NetDevice within a Node

 */

class NodeNetDeviceIndex : public TraceContextElement

{

public:

  NodeNetDeviceIndex ();

  NodeNetDeviceIndex (uint32_t index);

  /**

   * \returns the index of the NetDevice within its container Node.

   */

  uint32_t Get (void) const;

  void Print (std::ostream &os) const;

  std::string GetTypeName (void) const;

  static uint16_t GetUid (void);

private:

  uint32_t m_index;

};

/**

 * \brief hold in a TraceContext the index of an Application within a Node

 */

class NodeApplicationIndex : public TraceContextElement

{

public:

  NodeApplicationIndex ();

  NodeApplicationIndex (uint32_t index);

  /**

   * \returns the index of the Application within its container Node.

   */

  uint32_t Get (void) const;

  void Print (std::ostream &os) const;

  std::string GetTypeName (void) const;

  static uint16_t GetUid (void);

private:

  uint32_t m_index;

};

/**

 * \brief A network Node.

 *

 * This class holds together:

 *   - a list of NetDevice objects which represent the network interfaces

 *     of this node which are connected to other Node instances through

 *     Channel instances.

 *   - a list of Application objects which represent the userspace

 *     traffic generation applications which interact with the Node

 *     through the Socket API.

 *   - a node Id: a unique per-node identifier.

 *   - a system Id: a unique Id used for parallel simulations.

 *   - a trace resolver which can be used to connect user trace sinks

 *     to the node's trace sources.

 *

 * Every Node created is added to the NodeList automatically.

 */

class Node : public Object

{

public:

  /**

   * Must be invoked by subclasses only.

   */

  Node();

  /**

   * \param systemId a unique integer used for parallel simulations.

   *

   * Must be invoked by subclasses only.

   */

  Node(uint32_t systemId);

  virtual ~Node();

  /**

   * \returns the unique id of this node.

   * 

   * This unique id happens to be also the index of the Node into

   * the NodeList. 

   */

  uint32_t GetId (void) const;

  /**

   * \returns the system id for parallel simulations associated

   *          to this node.

   */

  uint32_t GetSystemId (void) const;

  /**

   * \param device NetDevice to associate to this node.

   * \returns the index of the NetDevice into the Node's list of

   *          NetDevice.

   *

   * Associate this device to this node.

   * This method is called automatically from NetDevice::NetDevice

   * so the user has little reason to call this method himself.

   * The index returned is always non-zero.

   */

  uint32_t AddDevice (Ptr<NetDevice> device);

  /**

   * \param index the index of the requested NetDevice

   * \returns the requested NetDevice associated to this Node.

   *

   * The indexes used by the GetDevice method start at one and

   * end at GetNDevices ()

   */

  Ptr<NetDevice> GetDevice (uint32_t index) const;

  /**

   * \returns the number of NetDevice instances associated

   *          to this Node.

   */

  uint32_t GetNDevices (void) const;

  /**

   * \param application Application to associate to this node.

   * \returns the index of the Application within the Node's list

   *          of Application.

   *

   * Associated this Application to this Node. This method is called

   * automatically from Application::Application so the user

   * has little reasons to call this method directly.

   */

  uint32_t AddApplication (Ptr<Application> application);

  /**

   * \param index

   * \returns the application associated to this requested index

   *          within this Node.

   */

  Ptr<Application> GetApplication (uint32_t index) const;

  /**

   * \returns the number of applications associated to this Node.

   */

  uint32_t GetNApplications (void) const;

  /**

   * A protocol handler

   */

  typedef Callback<void,Ptr<NetDevice>, Ptr<Packet>,uint16_t,const Address &> ProtocolHandler;

  /**

   * \param handler the handler to register

   * \param protocolType the type of protocol this handler is 

   *        interested in. This protocol type is a so-called

   *        EtherType, as registered here:

   *        http://standards.ieee.org/regauth/ethertype/eth.txt

   *        the value zero is interpreted as matching all

   *        protocols.

   * \param device the device attached to this handler. If the

   *        value is zero, the handler is attached to all

   *        devices on this node.

   */

  void RegisterProtocolHandler (ProtocolHandler handler, 

                                uint16_t protocolType,

                                Ptr<NetDevice> device);

  /**

   * \param handler the handler to unregister

   *

   * After this call returns, the input handler will never

   * be invoked anymore.

   */

  void UnregisterProtocolHandler (ProtocolHandler handler);

protected:

  virtual Ptr<TraceResolver> GetTraceResolver (void) const;

  /**

   * The dispose method. Subclasses must override this method

   * and must chain up to it by calling Node::DoDispose at the

   * end of their own DoDispose method.

   */

  virtual void DoDispose (void);

private:

  /**

   * \param device the device added to this Node.

   *

   * This method is invoked whenever a user calls Node::AddDevice.

   * Subclasses are expected to call NetDevice::SetReceiveCallback

   * at this point to setup the node's receive function for

   * the NetDevice packets.

   */

  virtual void NotifyDeviceAdded (Ptr<NetDevice> device);

  bool ReceiveFromDevice (Ptr<NetDevice> device, Ptr<Packet>, 

                          uint16_t protocol, const Address &from);

  void Construct (void);

  struct ProtocolHandlerEntry {

    ProtocolHandler handler;

    uint16_t protocol;

    Ptr<NetDevice> device;

  };

  typedef std::vector<struct Node::ProtocolHandlerEntry> ProtocolHandlerList;

  uint32_t    m_id;         // Node id for this node

  uint32_t    m_sid;        // System id for this node

  std::vector<Ptr<NetDevice> > m_devices;

  std::vector<Ptr<Application> > m_applications;

  ProtocolHandlerList m_handlers;

};

} //namespace ns3

#endif /* NODE_H */