node.h

/* -*- 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/ptr.h"
#include "ns3/net-device.h"
#include "ns3/common-cognitive-header.h"

namespace ns3 {

class Application;
class Packet;
class Address;


class Node : public Object
{
public:
  static TypeId GetTypeId (void);

  Node();
  Node(uint32_t systemId);

  virtual ~Node();

  uint32_t GetId (void) const;

  uint32_t GetSystemId (void) const;

  uint32_t AddDevice (Ptr<NetDevice> device);
  Ptr<NetDevice> GetDevice (uint32_t index) const;
  uint32_t GetNDevices (void) const;

  uint32_t AddApplication (Ptr<Application> application);
  Ptr<Application> GetApplication (uint32_t index) const;

  uint32_t GetNApplications (void) const;

  typedef Callback<void,Ptr<NetDevice>, Ptr<const Packet>,uint16_t,const Address &,
                   const Address &, NetDevice::PacketType> ProtocolHandler;
  void RegisterProtocolHandler (ProtocolHandler handler, 
                                uint16_t protocolType,
                                Ptr<NetDevice> device,
                                bool promiscuous=false);
  void UnregisterProtocolHandler (ProtocolHandler handler);

  typedef Callback<void,Ptr<NetDevice> > DeviceAdditionListener;
  void RegisterDeviceAdditionListener (DeviceAdditionListener listener);
  void UnregisterDeviceAdditionListener (DeviceAdditionListener listener);



  static bool ChecksumEnabled (void);
  void SetCognitiveRadio(bool isCR);
  bool IsCognitiveRadio(void);


protected:
  virtual void DoDispose (void);
  virtual void DoInitialize (void);
private:
  void NotifyDeviceAdded (Ptr<NetDevice> device);
  bool NonPromiscReceiveFromDevice (Ptr<NetDevice> device, Ptr<const Packet>, uint16_t protocol, const Address &from);
  bool PromiscReceiveFromDevice (Ptr<NetDevice> device, Ptr<const Packet>, uint16_t protocol,
                                 const Address &from, const Address &to, NetDevice::PacketType packetType);
  bool ReceiveFromDevice (Ptr<NetDevice> device, Ptr<const Packet>, uint16_t protocol,
                          const Address &from, const Address &to, NetDevice::PacketType packetType, bool promisc);

  void Construct (void);

  struct ProtocolHandlerEntry {
    ProtocolHandler handler;
    Ptr<NetDevice> device;
    uint16_t protocol;
    bool promiscuous;
  };
  typedef std::vector<struct Node::ProtocolHandlerEntry> ProtocolHandlerList;
  typedef std::vector<DeviceAdditionListener> DeviceAdditionListenerList;

  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;
  DeviceAdditionListenerList m_deviceAdditionListeners;
  bool m_isCognitiveRadio;
};

} // namespace ns3

#endif /* NODE_H */