#include <node.h>

Inheritance diagram for ns3::Node:

Collaboration diagram for ns3::Node:

Classes
struct	ProtocolHandlerEntry

Public Types
typedef Callback< void, Ptr < NetDevice > >	DeviceAdditionListener
typedef Callback< void, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, NetDevice::PacketType >	ProtocolHandler

Public Member Functions
	Node ()
	Node (uint32_t systemId)
virtual	~Node ()
uint32_t	AddApplication (Ptr< Application > application)
uint32_t	AddDevice (Ptr< NetDevice > device)
Ptr< Application >	GetApplication (uint32_t index) const
Ptr< NetDevice >	GetDevice (uint32_t index) const
uint32_t	GetId (void) const
uint32_t	GetNApplications (void) const
uint32_t	GetNDevices (void) const
uint32_t	GetSystemId (void) const
void	RegisterDeviceAdditionListener (DeviceAdditionListener listener)
void	RegisterProtocolHandler (ProtocolHandler handler, uint16_t protocolType, Ptr< NetDevice > device, bool promiscuous=false)
void	UnregisterDeviceAdditionListener (DeviceAdditionListener listener)
void	UnregisterProtocolHandler (ProtocolHandler handler)
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static bool	ChecksumEnabled (void)
static TypeId	GetTypeId (void)

Protected Member Functions
virtual void	DoDispose (void)
virtual void	DoInitialize (void)
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	NotifyNewAggregate (void)

Private Types
typedef std::vector < DeviceAdditionListener >	DeviceAdditionListenerList
typedef std::vector< struct Node::ProtocolHandlerEntry >	ProtocolHandlerList

Private Member Functions
void	Construct (void)
bool	NonPromiscReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet >, uint16_t protocol, const Address &from)
void	NotifyDeviceAdded (Ptr< NetDevice > device)
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)

Private Attributes
std::vector< Ptr< Application > >	m_applications
DeviceAdditionListenerList	m_deviceAdditionListeners
std::vector< Ptr< NetDevice > >	m_devices
ProtocolHandlerList	m_handlers
uint32_t	m_id
uint32_t	m_sid

Detailed Description

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.

Every Node created is added to the NodeList automatically.

Config Paths

ns3::Node is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]

Attributes

DeviceList: The list of devices associated to this Node.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::NetDevice >
- Flags: read
ApplicationList: The list of applications associated to this Node.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::Application >
- Flags: read
Id: The id (unique integer) of this Node.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Flags: read
SystemId: The systemId of this node: a unique integer used for parallel simulations.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Flags: write read

No TraceSources are defined for this type.

Definition at line 55 of file node.h.

Member Typedef Documentation

typedef Callback<void,Ptr<NetDevice> > ns3::Node::DeviceAdditionListener

A callback invoked whenever a device is added to a node.

Definition at line 173 of file node.h.

typedef std::vector<DeviceAdditionListener> ns3::Node::DeviceAdditionListenerList

private

Definition at line 223 of file node.h.

typedef Callback<void,Ptr<NetDevice>, Ptr<const Packet>,uint16_t,const Address &, const Address &, NetDevice::PacketType> ns3::Node::ProtocolHandler

A protocol handler

Parameters

device	a pointer to the net device which received the packet
packet	the packet received
protocol	the 16 bit protocol number associated with this packet. This protocol number is expected to be the same protocol number given to the Send method by the user on the sender side.
sender	the address of the sender
receiver	the address of the receiver; Note: this value is only valid for promiscuous mode protocol handlers. Note: If the L2 protocol does not use L2 addresses, the address reported here is the value of device->GetAddress().
packetType	type of packet received (broadcast/multicast/unicast/otherhost); Note: this value is only valid for promiscuous mode protocol handlers.

Definition at line 144 of file node.h.

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

private

Definition at line 222 of file node.h.

Constructor & Destructor Documentation

ns3::Node::Node ( )

Definition at line 74 of file node.cc.

References Construct(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

ns3::Node::Node ( uint32_t systemId )

Parameters

systemId a unique integer used for parallel simulations.

Definition at line 82 of file node.cc.

References Construct(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

ns3::Node::~Node ( )

virtual

Definition at line 97 of file node.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

uint32_t ns3::Node::AddApplication ( Ptr< Application > application )

Parameters

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.

Definition at line 146 of file node.cc.

References GetId(), ns3::Object::Initialize(), m_applications, NS_LOG_FUNCTION, ns3::Simulator::ScheduleWithContext(), ns3::Seconds(), and ns3::Application::SetNode().

Referenced by ns3::EpcHelper::AddEnb(), ns3::aodv::LoopbackTestCase::DoRun(), Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCase1::DoRun(), NscTcpLossTestCase1::DoRun(), Ns3TcpSocketTestCase2::DoRun(), NscTcpLossTestCase2::DoRun(), Ns3TcpCwndTestCase1::DoRun(), ns3::EpcS1uUlTestCase::DoRun(), Ns3TcpCwndTestCase2::DoRun(), ns3::EpcHelper::EpcHelper(), ns3::Ping6Helper::Install(), ns3::UdpServerHelper::Install(), ns3::UdpClientHelper::Install(), ns3::UdpTraceClientHelper::Install(), ns3::V4PingHelper::InstallPriv(), ns3::PacketSinkHelper::InstallPriv(), ns3::UdpEchoServerHelper::InstallPriv(), ns3::BulkSendHelper::InstallPriv(), ns3::OnOffHelper::InstallPriv(), ns3::UdpEchoClientHelper::InstallPriv(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Node::AddDevice ( Ptr< NetDevice > device )

Parameters

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.

Definition at line 117 of file node.cc.

References GetId(), ns3::Object::Initialize(), m_devices, ns3::MakeCallback(), NonPromiscReceiveFromDevice(), NotifyDeviceAdded(), NS_LOG_FUNCTION, ns3::Simulator::ScheduleWithContext(), ns3::Seconds(), ns3::NetDevice::SetIfIndex(), ns3::NetDevice::SetNode(), and ns3::NetDevice::SetReceiveCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Node::ChecksumEnabled ( void )

static

Returns: true if checksums are enabled, false otherwise.

Definition at line 265 of file node.cc.

References ns3::g_checksumEnabled, ns3::BooleanValue::Get(), ns3::GlobalValue::GetValue(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::CsmaNetDevice::AddHeader(), ns3::Ipv4L3Protocol::BuildHeader(), ns3::Ipv4L3Protocol::DoFragmentation(), ns3::UdpL4Protocol::Receive(), ns3::TcpL4Protocol::Receive(), ns3::Ipv4L3Protocol::Receive(), ns3::CsmaNetDevice::Receive(), ns3::V4Ping::Send(), ns3::UdpL4Protocol::Send(), ns3::TcpL4Protocol::Send(), ns3::Icmpv4L4Protocol::SendMessage(), ns3::TcpL4Protocol::SendPacket(), and ns3::Ipv4L3Protocol::SendWithHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Node::Construct ( void )

private

Definition at line 91 of file node.cc.

References ns3::NodeList::Add(), m_id, and NS_LOG_FUNCTION.

Referenced by Node().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Node::DoDispose ( void )

protectedvirtual

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.

Reimplemented from ns3::Object.

Definition at line 172 of file node.cc.

References ns3::Object::Dispose(), m_applications, m_deviceAdditionListeners, m_devices, m_handlers, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::Node::DoInitialize ( void )

protectedvirtual

This method is called only once by Object::Initialize. If the user calls Object::Initialize multiple times, DoInitialize is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject and AggregateObject from within this method.

Reimplemented from ns3::Object.

Definition at line 196 of file node.cc.

References ns3::Object::Initialize(), m_applications, m_devices, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Ptr< Application > ns3::Node::GetApplication ( uint32_t index ) const

Parameters

index

Returns: the application associated to this requested index within this Node.

Definition at line 157 of file node.cc.

References m_applications, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ns3::EpcHelper::AddEnb(), ns3::OnOffHelper::AssignStreams(), ns3::EpcS1uDlTestCase::DoRun(), ns3::EpcS1uUlTestCase::DoRun(), ns3::V4Ping::GetApplicationId(), and ns3::LteHelper::InstallSingleEnbDevice().

Here is the caller graph for this function:

Ptr< NetDevice > ns3::Node::GetDevice ( uint32_t index ) const

Parameters

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 ()

Definition at line 131 of file node.cc.

References m_devices, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the caller graph for this function:

uint32_t ns3::Node::GetId ( void ) const

Returns: the unique id of this node.

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

Definition at line 103 of file node.cc.

References m_id, and NS_LOG_FUNCTION.

uint32_t ns3::Node::GetNApplications ( void ) const

Returns: the number of applications associated to this Node.

Definition at line 165 of file node.cc.

References m_applications, and NS_LOG_FUNCTION.

Referenced by ns3::EpcHelper::AddEnb(), ns3::OnOffHelper::AssignStreams(), and ns3::V4Ping::GetApplicationId().

Here is the caller graph for this function:

uint32_t ns3::Node::GetNDevices ( void ) const

Returns: the number of NetDevice instances associated to this Node.

Definition at line 139 of file node.cc.

References m_devices, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4NixVectorRouting::BFS(), ns3::Socket::BindToNetDevice(), ns3::Ipv4NixVectorRouting::BuildNixVector(), ns3::Ipv4NixVectorRouting::BuildNixVectorLocal(), ns3::AnimationInterface::ConnectLte(), ns3::GlobalRouter::DiscoverLSAs(), ns3::LteEnbRrcProtocolIdeal::DoSendSystemInformation(), ns3::LteEnbRrcProtocolReal::DoSendSystemInformation(), ns3::LteEnbRrcProtocolIdeal::DoSendSystemInformationBlockType1(), ns3::LteEnbRrcProtocolReal::DoSendSystemInformationBlockType1(), ns3::UanHelper::EnableAscii(), ns3::AsciiTraceHelperForDevice::EnableAsciiImpl(), ns3::AthstatsHelper::EnableAthstats(), ns3::PcapHelperForDevice::EnablePcap(), ns3::Ipv4NixVectorRouting::FindNetDeviceForNixIndex(), ns3::Ipv4NixVectorRouting::FindTotalNeighbors(), ns3::PacketSocket::GetMinMtu(), ns3::Ipv4NixVectorRouting::NetDeviceIsBridged(), ns3::GlobalRouter::NetDeviceIsBridged(), PrintGnuplottableEnbListToFile(), PrintGnuplottableUeListToFile(), ns3::MpiInterface::ReceiveMessages(), ns3::PacketSocket::SendTo(), ns3::LteUeRrcProtocolIdeal::SetEnbRrcSapProvider(), ns3::LteUeRrcProtocolReal::SetEnbRrcSapProvider(), ns3::Ipv4L3Protocol::SetupLoopback(), ns3::Ipv6L3Protocol::SetupLoopback(), and ns3::AnimationInterface::StartAnimation().

Here is the caller graph for this function:

uint32_t ns3::Node::GetSystemId ( void ) const

Returns: the system id for parallel simulations associated to this node.

Definition at line 110 of file node.cc.

References m_sid, and NS_LOG_FUNCTION.

Referenced by ns3::DistributedSimulatorImpl::CalculateLookAhead(), ns3::GlobalRouteManagerImpl::InitializeRoutes(), ns3::PointToPointHelper::Install(), and ns3::MpiInterface::SendPacket().

Here is the caller graph for this function:

TypeId ns3::Node::GetTypeId ( void )

static

Reimplemented from ns3::Object.

Definition at line 47 of file node.cc.

References ns3::TypeId::ATTR_GET, ns3::TypeId::ATTR_SET, m_applications, m_devices, m_id, m_sid, ns3::MakeObjectVectorAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

bool ns3::Node::NonPromiscReceiveFromDevice	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	packet,
		uint16_t	protocol,
		const Address &	from
	)

private

Definition at line 282 of file node.cc.

References ns3::NetDevice::GetAddress(), NS_LOG_FUNCTION, and ReceiveFromDevice().

Referenced by AddDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Node::NotifyDeviceAdded ( Ptr< NetDevice > device )

private

Definition at line 349 of file node.cc.

References m_deviceAdditionListeners, and NS_LOG_FUNCTION.

Referenced by AddDevice().

Here is the caller graph for this function:

bool ns3::Node::PromiscReceiveFromDevice	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	packet,
		uint16_t	protocol,
		const Address &	from,
		const Address &	to,
		NetDevice::PacketType	packetType
	)

private

Definition at line 274 of file node.cc.

References NS_LOG_FUNCTION, and ReceiveFromDevice().

Referenced by RegisterProtocolHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Node::ReceiveFromDevice	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	packet,
		uint16_t	protocol,
		const Address &	from,
		const Address &	to,
		NetDevice::PacketType	packetType,
		bool	promisc
	)

private

Definition at line 290 of file node.cc.

References ns3::Simulator::GetContext(), GetId(), ns3::NetDevice::GetIfIndex(), ns3::Object::GetInstanceTypeId(), ns3::TypeId::GetName(), ns3::Packet::GetUid(), m_handlers, NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by NonPromiscReceiveFromDevice(), and PromiscReceiveFromDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Node::RegisterDeviceAdditionListener ( DeviceAdditionListener listener )

Parameters

listener the listener to add

Add a new listener to the list of listeners for the device-added event. When a new listener is added, it is notified of the existance of all already-added devices to make discovery of devices easier.

Definition at line 322 of file node.cc.

References m_deviceAdditionListeners, m_devices, and NS_LOG_FUNCTION.

void ns3::Node::RegisterProtocolHandler	(	ProtocolHandler	handler,
		uint16_t	protocolType,
		Ptr< NetDevice >	device,
		bool	promiscuous = `false`
	)

Parameters

handler	the handler to register
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.
device	the device attached to this handler. If the value is zero, the handler is attached to all devices on this node.
promiscuous	whether to register a promiscuous mode handler

Definition at line 216 of file node.cc.

References ns3::Node::ProtocolHandlerEntry::device, ns3::Node::ProtocolHandlerEntry::handler, m_devices, m_handlers, ns3::MakeCallback(), NS_LOG_FUNCTION, PromiscReceiveFromDevice(), ns3::Node::ProtocolHandlerEntry::promiscuous, ns3::Node::ProtocolHandlerEntry::protocol, and ns3::NetDevice::SetPromiscReceiveCallback().

Referenced by ns3::BridgeNetDevice::AddBridgePort(), ns3::MeshPointDevice::AddInterface(), ns3::Ipv4L3Protocol::AddInterface(), ns3::Ipv6L3Protocol::AddInterface(), ns3::PacketSocket::DoBind(), ns3::Ipv4L3Protocol::SetupLoopback(), and ns3::Ipv6L3Protocol::SetupLoopback().

Here is the call graph for this function: