ns3::Node Class Reference

A network Node. More...

#include "node.h"

Inheritance diagram for ns3::Node:

Classes
struct	ProtocolHandlerEntry
	Protocol handler entry. More...

Public Types
typedef Callback< void, Ptr< NetDevice > >	DeviceAdditionListener
	A callback invoked whenever a device is added to a node. More...
typedef Callback< void, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, NetDevice::PacketType >	ProtocolHandler
	A protocol handler. More...

Public Member Functions
	Node ()
	Node (uint32_t systemId)
virtual	~Node ()
uint32_t	AddApplication (Ptr< Application > application)
	Associate an Application to this Node. More...
uint32_t	AddDevice (Ptr< NetDevice > device)
	Associate a NetDevice to this node. More...
Ptr< Application >	GetApplication (uint32_t index) const
	Retrieve the index-th Application associated to this node. More...
Ptr< NetDevice >	GetDevice (uint32_t index) const
	Retrieve the index-th NetDevice associated to this node. More...
uint32_t	GetId (void) const
Time	GetLocalTime (void) const
	In the future, ns3 nodes may have clock that returned a local time different from the virtual time Simulator::Now(). More...
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 ()
	Constructor. More...
virtual	~Object ()
	Destructor. More...
void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...
void	Dispose (void)
	Dispose of this Object. More...
AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...
virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...
template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...
void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...
bool	IsInitialized (void) const
	Check if the object has been initialized. More...
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...
	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...
uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. More...
void	Ref (void) const
	Increment the reference count. More...
void	Unref (void) const
	Decrement the reference count. More...
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...
void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...
bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...
void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static bool	ChecksumEnabled (void)
static TypeId	GetTypeId (void)
	Get the type ID. More...
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
virtual void	DoDispose (void)
	The dispose method. More...
virtual void	DoInitialize (void)
	Initialize() implementation. More...
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...
virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...
virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Private Types
typedef std::vector< DeviceAdditionListener >	DeviceAdditionListenerList
	Typedef for NetDevice addition listeners container. More...
typedef std::vector< struct Node::ProtocolHandlerEntry >	ProtocolHandlerList
	Typedef for protocol handlers container. More...

Private Member Functions
void	Construct (void)
	Finish node's construction by setting the correct node ID. More...
bool	NonPromiscReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, const Address &from)
	Receive a packet from a device in non-promiscuous mode. More...
void	NotifyDeviceAdded (Ptr< NetDevice > device)
	Notifies all the DeviceAdditionListener about the new device added. More...
bool	PromiscReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType)
	Receive a packet from a device in promiscuous mode. More...
bool	ReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet >, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType, bool promisc)
	Receive a packet from a device. More...

Private Attributes
std::vector< Ptr< Application > >	m_applications
	Applications associated to this node. More...
DeviceAdditionListenerList	m_deviceAdditionListeners
	Device addition listeners in the node. More...
std::vector< Ptr< NetDevice > >	m_devices
	Devices associated to this node. More...
ProtocolHandlerList	m_handlers
	Protocol handlers in the node. More...
uint32_t	m_id
	Node id for this node. More...
uint32_t	m_sid
	System id for this node. More...

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

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.
Size of this type is 136 bytes (on a 64-bit architecture).

Definition at line 56 of file node.h.

Member Typedef Documentation

DeviceAdditionListener

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

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

Definition at line 188 of file node.h.

DeviceAdditionListenerList

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

private

Typedef for NetDevice addition listeners container.

Definition at line 283 of file node.h.

ProtocolHandler

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 159 of file node.h.

ProtocolHandlerList

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

private

Typedef for protocol handlers container.

Definition at line 281 of file node.h.

Constructor & Destructor Documentation

Node() [1/2]

ns3::Node::Node

(

)

Definition at line 78 of file node.cc.

References Construct(), and NS_LOG_FUNCTION.

Node() [2/2]

ns3::Node::Node

(

uint32_t

systemId

)

Parameters

systemId

a unique integer used for parallel simulations.

Definition at line 86 of file node.cc.

References Construct(), and NS_LOG_FUNCTION.

~Node()

ns3::Node::~Node ( )

virtual

Definition at line 101 of file node.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

AddApplication()

uint32_t ns3::Node::AddApplication

(

Ptr< Application >

application

)

Associate an Application to this Node.

Parameters

application

Application to associate to this node.

Returns

the index of the Application within the Node's list of Application.

Definition at line 157 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::PointToPointEpcHelper::AddEnb(), ns3::EmuEpcHelper::AddEnb(), ns3::EmuEpcHelper::DoInitialize(), Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCase1::DoRun(), NscTcpLossTestCase1::DoRun(), SpectrumIdealPhyTestCase::DoRun(), Ns3TcpSocketTestCase2::DoRun(), NscTcpLossTestCase2::DoRun(), EpcS1uUlTestCase::DoRun(), Ns3TcpCwndTestCase2::DoRun(), Bug730TestCase::DoRun(), Bug2222TestCase::DoRun(), ns3::Ping6Helper::Install(), ns3::UdpServerHelper::Install(), ns3::RadvdHelper::Install(), ns3::UdpClientHelper::Install(), ns3::UdpTraceClientHelper::Install(), ns3::DhcpHelper::InstallDhcpClientPriv(), ns3::DhcpHelper::InstallDhcpServer(), ns3::V4PingHelper::InstallPriv(), ns3::PacketSinkHelper::InstallPriv(), ns3::ThreeGppHttpClientHelper::InstallPriv(), ns3::UdpEchoServerHelper::InstallPriv(), ns3::BulkSendHelper::InstallPriv(), ns3::OnOffHelper::InstallPriv(), ns3::WaveBsmHelper::InstallPriv(), ns3::ThreeGppHttpServerHelper::InstallPriv(), ns3::UdpEchoClientHelper::InstallPriv(), ns3::PointToPointEpcHelper::PointToPointEpcHelper(), and OcbWifiMacTestCase::PostDeviceConfiguration().

AddDevice()

uint32_t ns3::Node::AddDevice

(

Ptr< NetDevice >

device

)

Associate a NetDevice to this node.

Parameters

device

NetDevice to associate to this node.

Returns

the index of the NetDevice into the Node's list of NetDevice.

Definition at line 128 of file node.cc.

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

Referenced by TcpTestCase::AddSimpleNetDevice(), AddSimpleNetDevice(), TcpTestCase::AddSimpleNetDevice6(), BuildSimpleTopology(), ns3::MeshHelper::CreateInterface(), WifiTest::CreateOne(), InterferenceHelperSequenceTest::CreateOne(), ThreeGppHttpObjectTestCase::CreateSimpleInternetNode(), ns3::EmuEpcHelper::DoInitialize(), Ipv4L3ProtocolTestCase::DoRun(), PointToPointTest::DoRun(), Ipv6L3ProtocolTestCase::DoRun(), LrWpanEdTestCase::DoRun(), LrWpanCollisionTestCase::DoRun(), LrWpanErrorDistanceTestCase::DoRun(), Ipv4PacketInfoTagTest::DoRun(), SixlowpanFragmentationTest::DoRun(), SixlowpanHc1ImplTest::DoRun(), Ipv6RipngTest::DoRun(), Ipv4RipTest::DoRun(), Ipv4ForwardingTest::DoRun(), SixlowpanIphcImplTest::DoRun(), Ipv4StaticRoutingSlash32TestCase::DoRun(), Ipv4HeaderTest::DoRun(), LrWpanAckTestCase::DoRun(), Ipv6PacketInfoTagTest::DoRun(), LrWpanCcaTestCase::DoRun(), Ipv6FragmentationTest::DoRun(), Ipv6RipngCountToInfinityTest::DoRun(), Ipv4RipCountToInfinityTest::DoRun(), DcfImmediateAccessBroadcastTestCase::DoRun(), Ipv6RipngSplitHorizonStrategyTest::DoRun(), Ipv4RipSplitHorizonStrategyTest::DoRun(), Ipv4GlobalRoutingSlash32TestCase::DoRun(), Bug2831TestCase::DoRun(), ns3::BridgeHelper::Install(), ns3::TapBridgeHelper::Install(), ns3::SixLowPanHelper::Install(), ns3::LrWpanHelper::Install(), ns3::PointToPointHelper::Install(), ns3::WaveformGeneratorHelper::Install(), ns3::TvSpectrumTransmitterHelper::Install(), ns3::AdhocAlohaNoackIdealPhyHelper::Install(), ns3::SpectrumAnalyzerHelper::Install(), ns3::MeshHelper::Install(), ns3::WimaxHelper::Install(), ns3::WaveHelper::Install(), ns3::UanHelper::Install(), ns3::WifiHelper::Install(), ns3::TvSpectrumTransmitterHelper::InstallAdjacent(), ns3::FdNetDeviceHelper::InstallPriv(), ns3::SimpleNetDeviceHelper::InstallPriv(), ns3::CsmaHelper::InstallPriv(), ns3::PointToPointEpcHelper::PointToPointEpcHelper(), TbfQueueDiscTestCase::RunTbfTest(), ns3::Ipv4L3Protocol::SetupLoopback(), ns3::Ipv6L3Protocol::SetupLoopback(), and Tunnel::Tunnel().

ChecksumEnabled()

bool ns3::Node::ChecksumEnabled ( void  )

static

Returns

true if checksums are enabled, false otherwise.

Definition at line 276 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::SixLowPanNetDevice::DecompressLowPanUdpNhc(), ns3::Ipv4L3Protocol::DoFragmentation(), ns3::LrWpanMac::McpsDataRequest(), ns3::TcpL4Protocol::PacketReceived(), ns3::LrWpanMac::PdDataIndication(), ns3::Ipv4L3Protocol::Receive(), ns3::CsmaNetDevice::Receive(), ns3::UdpL4Protocol::Receive(), ns3::V4Ping::Send(), ns3::UdpL4Protocol::Send(), ns3::LrWpanMac::SendAck(), ns3::Icmpv4L4Protocol::SendMessage(), ns3::TcpL4Protocol::SendPacketV4(), ns3::TcpL4Protocol::SendPacketV6(), ns3::olsr::Bug780Test::SendPing(), and ns3::Ipv4L3Protocol::SendWithHeader().

Construct()

void ns3::Node::Construct ( void  )

private

Finish node's construction by setting the correct node ID.

Definition at line 95 of file node.cc.

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

Referenced by Node().

DoDispose()

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 183 of file node.cc.

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

DoInitialize()

void ns3::Node::DoInitialize ( void  )

protectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls 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 207 of file node.cc.

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

GetApplication()

Ptr< Application > ns3::Node::GetApplication

(

uint32_t

index

)

const

Retrieve the index-th Application associated to this node.

Parameters

index

the index of the requested Application

Returns

the requested Application.

Definition at line 168 of file node.cc.

References m_applications, NS_ASSERT_MSG(), and NS_LOG_FUNCTION.

Referenced by ns3::PointToPointEpcHelper::AddEnb(), ns3::EmuEpcHelper::AddEnb(), ns3::OnOffHelper::AssignStreams(), ns3::WaveBsmHelper::AssignStreams(), LteIpv6RoutingTestCase::DoRun(), EpcS1uDlTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), and ns3::V4Ping::GetApplicationId().

GetDevice()

Ptr< NetDevice > ns3::Node::GetDevice

(

uint32_t

index

)

const

Retrieve the index-th NetDevice associated to this node.

Parameters

index

the index of the requested NetDevice

Returns

the requested NetDevice.

Definition at line 142 of file node.cc.

References m_devices, NS_ASSERT_MSG(), and NS_LOG_FUNCTION.

Referenced by ns3::PointToPointEpcHelper::AddX2Interface(), ns3::EmuEpcHelper::AddX2Interface(), ns3::Socket::BindToNetDevice(), ns3::GlobalRouter::DiscoverLSAs(), ns3::PacketSocket::DoBind(), AcousticModemEnergyTestCase::DoRun(), InterferenceHelperSequenceTest::DoRun(), StaWifiMacScanningTestCase::DoRun(), ns3::LteEnbRrcProtocolIdeal::DoSendSystemInformation(), ns3::LteEnbRrcProtocolReal::DoSendSystemInformation(), ns3::UanHelper::EnableAscii(), ns3::AsciiTraceHelperForDevice::EnableAsciiImpl(), ns3::AthstatsHelper::EnableAthstats(), ns3::PcapHelperForDevice::EnablePcap(), ns3::PacketSocket::GetMinMtu(), ns3::TrafficControlLayer::GetRootQueueDiscOnDeviceByIndex(), ns3::PacketSocket::GetSockName(), ns3::AcousticModemEnergyModel::HandleEnergyDepletion(), ns3::AcousticModemEnergyModel::HandleEnergyRecharged(), ns3::Radvd::HandleRead(), ns3::DhcpServer::NetHandler(), OcbWifiMacTestCase::PostDeviceConfiguration(), PrintGnuplottableEnbListToFile(), PrintGnuplottableUeListToFile(), PrintPosition(), ns3::Rip::Receive(), ns3::RipNg::Receive(), ns3::GrantedTimeWindowMpiInterface::ReceiveMessages(), ns3::NullMessageMpiInterface::ReceiveMessages(), ns3::olsr::RoutingProtocol::RecvOlsr(), Experiment::Run(), AcousticModemEnergyTestCase::SendOnePacket(), AcousticModemEnergyDepletionTestCase::SendOnePacket(), UanExperiment::SendSinglePacket(), ns3::PacketSocket::SendTo(), ns3::LteUeRrcProtocolIdeal::SetEnbRrcSapProvider(), ns3::LteUeRrcProtocolReal::SetEnbRrcSapProvider(), ns3::Ipv4L3Protocol::SetupLoopback(), ns3::Ipv6L3Protocol::SetupLoopback(), PowerRateAdaptationTest::TestAparf(), PowerRateAdaptationTest::TestParf(), PowerRateAdaptationTest::TestRrpaa(), ns3::PyViz::TraceNetDevRxCommon(), ns3::PyViz::TraceNetDevTxCommon(), StaWifiMacScanningTestCase::TurnApOff(), and StaWifiMacScanningTestCase::TurnBeaconGenerationOn().

GetId()

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 107 of file node.cc.

References m_id, and NS_LOG_FUNCTION.

Referenced by ns3::LteHelper::ActivateDataRadioBearer(), AddApplication(), AddDevice(), ns3::TcpSocketBase::AddOptionSack(), ns3::TcpSocketBase::AddOptionSackPermitted(), ns3::TcpSocketBase::AddOptionTimestamp(), ns3::TcpSocketBase::AddOptionWScale(), ns3::GlobalRouter::BuildNetworkLSAs(), ns3::TcpSocketBase::CalculateWScale(), ns3::AcousticModemEnergyModel::ChangeState(), ThreeGppHttpObjectTestCase::ClientRxEmbeddedObjectCallback(), ThreeGppHttpObjectTestCase::ClientRxMainObjectCallback(), ns3::MobilityHelper::CourseChanged(), ns3::Ipv4GlobalRoutingHelper::Create(), Bug772ChainTest::CreateDevices(), ns3::GlobalRouteManagerImpl::DeleteGlobalRoutes(), ns3::GlobalRouter::DiscoverLSAs(), ns3::LteEnbPhy::DoInitialize(), ns3::LteUePhy::DoInitialize(), WifiMsduAggregatorThroughputTest::DoRun(), SixlowpanFragmentationTest::DoRun(), ns3::aodv::LoopbackTestCase::DoRun(), Ipv4FragmentationTest::DoRun(), Ipv6FragmentationTest::DoRun(), ns3::SixLowPanNetDevice::DoSend(), ns3::AsciiTraceHelperForDevice::EnableAsciiImpl(), ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4Impl(), ns3::InternetStackHelper::EnableAsciiIpv4Internal(), ns3::AsciiTraceHelperForIpv6::EnableAsciiIpv6Impl(), ns3::InternetStackHelper::EnableAsciiIpv6Internal(), ns3::PcapHelperForDevice::EnablePcap(), ns3::PcapHelperForIpv4::EnablePcapIpv4(), ns3::PcapHelperForIpv6::EnablePcapIpv6(), ns3::BsmApplication::GenerateWaveTraffic(), ns3::PcapHelper::GetFilenameFromDevice(), ns3::AsciiTraceHelper::GetFilenameFromDevice(), ns3::PcapHelper::GetFilenameFromInterfacePair(), ns3::AsciiTraceHelper::GetFilenameFromInterfacePair(), ns3::PyViz::GetPacketDropSamples(), ns3::PyViz::GetTransmissionSamples(), ns3::AcousticModemEnergyModel::HandleEnergyDepletion(), ns3::AcousticModemEnergyModel::HandleEnergyRecharged(), ns3::BsmApplication::HandleReceivedBsmPacket(), ns3::if(), ns3::BuildingsHelper::Install(), ns3::BridgeHelper::Install(), ns3::TapBridgeHelper::Install(), ns3::SixLowPanHelper::Install(), ns3::SpectrumAnalyzerHelper::Install(), HwmpProactiveRegressionTest::InstallApplications(), FlameRegressionTest::InstallApplications(), HwmpDoRfRegressionTest::InstallApplications(), HwmpSimplestRegressionTest::InstallApplications(), HwmpReactiveRegressionTest::InstallApplications(), ns3::Ipv4L3Protocol::IpForward(), ns3::Ipv6L3Protocol::IpForward(), ns3::Ipv4L3Protocol::IpMulticastForward(), ns3::Ipv6L3Protocol::IpMulticastForward(), ns3::Ipv4FlowProbe::Ipv4FlowProbe(), ns3::Ipv6FlowProbe::Ipv6FlowProbe(), ns3::ArpL3Protocol::Lookup(), ns3::AnimationInterface::OutputCsmaPacket(), ns3::AnimationInterface::OutputWirelessPacketRxInfo(), ns3::AnimationInterface::OutputWirelessPacketTxInfo(), ns3::Ipv4RoutingHelper::PrintArpCache(), ns3::Ipv4RoutingHelper::PrintArpCacheEvery(), ns3::Ipv6RoutingHelper::PrintNdiscCache(), ns3::Ipv6RoutingHelper::PrintNdiscCacheEvery(), PrintReceivedPacket(), PrintReceivedRoutingPacket(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::TcpSocketBase::ProcessOptionSackPermitted(), ns3::TcpSocketBase::ProcessOptionTimestamp(), ns3::TcpSocketBase::ProcessOptionWScale(), ns3::ArpL3Protocol::Receive(), ns3::Ipv6L3Protocol::Receive(), ns3::Ipv4L3Protocol::Receive(), ChannelAccessTestCase::Receive(), ns3::TapBridge::ReceiveFromBridgedDevice(), ReceiveFromDevice(), ns3::GrantedTimeWindowMpiInterface::ReceiveMessages(), ns3::NullMessageMpiInterface::ReceiveMessages(), ns3::AnimationInterface::RecursiveIpv4RoutePathSearch(), ns3::Ipv4ListRouting::RouteInput(), ns3::Ipv6ListRouting::RouteInput(), ns3::olsr::RoutingProtocol::RouteInput(), ns3::olsr::RoutingProtocol::RouteOutput(), ns3::LoopbackNetDevice::Send(), ns3::V4Ping::Send(), ns3::ArpL3Protocol::SendArpReply(), ns3::ArpL3Protocol::SendArpRequest(), ns3::aodv::LoopbackTestCase::SendData(), Ipv4StaticRoutingSlash32TestCase::SendData(), SixlowpanHc1ImplTest::SendData(), Ipv6ForwardingTest::SendData(), Ipv6RipngTest::SendData(), Ipv4RipTest::SendData(), Ipv4ForwardingTest::SendData(), SixlowpanIphcImplTest::SendData(), Ipv4RawSocketImplTest::SendData(), Ipv6RawSocketImplTest::SendData(), Bug772ChainTest::SendData(), HwmpProactiveRegressionTest::SendData(), FlameRegressionTest::SendData(), HwmpSimplestRegressionTest::SendData(), HwmpReactiveRegressionTest::SendData(), UdpSocketImplTest::SendData(), Ipv4RipCountToInfinityTest::SendData(), Ipv6RipngCountToInfinityTest::SendData(), Ipv4GlobalRoutingSlash32TestCase::SendData(), Ipv4RawSocketImplTest::SendData_IpHdr(), Ipv4HeaderTest::SendData_IpHdr_Dscp(), HwmpDoRfRegressionTest::SendDataA(), HwmpDoRfRegressionTest::SendDataB(), HwmpDoRfRegressionTest::SendDataC(), UdpSocketImplTest::SendDataTo(), Udp6SocketImplTest::SendDataTo(), ns3::LoopbackNetDevice::SendFrom(), Experiment::SendMultiDestinations(), ns3::LteTestMac::SendTxOpportunity(), ns3::GlobalRoutingLSA::SetNode(), showPosition(), ns3::GlobalRouteManagerImpl::SPFAddASExternal(), ns3::GlobalRouteManagerImpl::SPFIntraAddRouter(), ns3::GlobalRouteManagerImpl::SPFIntraAddStub(), ns3::GlobalRouteManagerImpl::SPFIntraAddTransit(), ns3::LteTestRrc::Start(), ns3::BsmApplication::StartApplication(), ns3::FdNetDevice::StartDevice(), ns3::TapBridge::StartTapDevice(), ns3::PyViz::TraceNetDevRxCommon(), ns3::AnimationInterface::TrackIpv4L3ProtocolCounters(), ns3::AnimationInterface::TrackQueueCounters(), ns3::AnimationInterface::TrackWifiMacCounters(), ns3::AnimationInterface::TrackWifiPhyCounters(), ns3::AnimationInterface::UpdateLinkDescription(), and WifiInterferenceTestCase::WifiSimpleInterference().

GetLocalTime()

Time ns3::Node::GetLocalTime

(

void

)

const

In the future, ns3 nodes may have clock that returned a local time different from the virtual time Simulator::Now().

This function is currently a placeholder to ease the development of this feature. For now, it is only an alias to Simulator::Now()

Returns

The time as seen by this node

Definition at line 114 of file node.cc.

References ns3::Simulator::Now(), and NS_LOG_FUNCTION.

GetNApplications()

uint32_t ns3::Node::GetNApplications

(

void

)

const

Returns

the number of Application instances associated to this Node.

Definition at line 176 of file node.cc.

References m_applications, and NS_LOG_FUNCTION.

Referenced by ns3::PointToPointEpcHelper::AddEnb(), ns3::EmuEpcHelper::AddEnb(), ns3::OnOffHelper::AssignStreams(), ns3::WaveBsmHelper::AssignStreams(), and ns3::V4Ping::GetApplicationId().

GetNDevices()

uint32_t ns3::Node::GetNDevices

(

void

)

const

Returns

the number of NetDevice instances associated to this Node.

Definition at line 150 of file node.cc.

References m_devices, and NS_LOG_FUNCTION.

Referenced by ns3::EmuEpcHelper::AddX2Interface(), ns3::Socket::BindToNetDevice(), ns3::GlobalRouter::DiscoverLSAs(), ns3::LteEnbRrcProtocolIdeal::DoSendSystemInformation(), ns3::LteEnbRrcProtocolReal::DoSendSystemInformation(), ns3::UanHelper::EnableAscii(), ns3::AsciiTraceHelperForDevice::EnableAsciiImpl(), ns3::AthstatsHelper::EnableAthstats(), ns3::PcapHelperForDevice::EnablePcap(), ns3::PacketSocket::GetMinMtu(), ns3::TrafficControlLayer::GetNDevices(), PrintGnuplottableEnbListToFile(), PrintGnuplottableUeListToFile(), ns3::GrantedTimeWindowMpiInterface::ReceiveMessages(), ns3::NullMessageMpiInterface::ReceiveMessages(), ns3::PacketSocket::SendTo(), ns3::LteUeRrcProtocolIdeal::SetEnbRrcSapProvider(), ns3::LteUeRrcProtocolReal::SetEnbRrcSapProvider(), ns3::Ipv4L3Protocol::SetupLoopback(), and ns3::Ipv6L3Protocol::SetupLoopback().

GetSystemId()

uint32_t ns3::Node::GetSystemId

(

void

)

const

Returns

the system id for parallel simulations associated to this node.

Definition at line 121 of file node.cc.

References m_sid, and NS_LOG_FUNCTION.

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

GetTypeId()

TypeId ns3::Node::GetTypeId ( void  )

static

Get the type ID.

Returns

the object TypeId

Definition at line 50 of file node.cc.

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

NonPromiscReceiveFromDevice()

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

private

Receive a packet from a device in non-promiscuous mode.

Parameters

device	the device
packet	the packet
protocol	the protocol
from	the sender

Returns

true if the packet has been delivered to a protocol handler.

Definition at line 293 of file node.cc.

References NS_LOG_FUNCTION, and ReceiveFromDevice().

Referenced by AddDevice().

NotifyDeviceAdded()

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

private

Notifies all the DeviceAdditionListener about the new device added.

Parameters

device

the added device to notify.

Definition at line 360 of file node.cc.

References m_deviceAdditionListeners, and NS_LOG_FUNCTION.

Referenced by AddDevice().

PromiscReceiveFromDevice()

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

private

Receive a packet from a device in promiscuous mode.

Parameters

device	the device
packet	the packet
protocol	the protocol
from	the sender
to	the destination
packetType	the packet type

Returns

true if the packet has been delivered to a protocol handler.

Definition at line 285 of file node.cc.

References NS_LOG_FUNCTION, and ReceiveFromDevice().

Referenced by RegisterProtocolHandler().

ReceiveFromDevice()

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

Receive a packet from a device.

Parameters

device	the device
packet	the packet
protocol	the protocol
from	the sender
to	the destination
packetType	the packet type
promisc	true if received in promiscuous mode

Returns

true if the packet has been delivered to a protocol handler.

Definition at line 301 of file node.cc.

References ns3::Simulator::GetContext(), GetId(), ns3::Packet::GetUid(), m_handlers, NS_ASSERT_MSG(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by NonPromiscReceiveFromDevice(), and PromiscReceiveFromDevice().

RegisterDeviceAdditionListener()

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 existence of all already-added devices to make discovery of devices easier.

Definition at line 333 of file node.cc.

References m_deviceAdditionListeners, m_devices, and NS_LOG_FUNCTION.

RegisterProtocolHandler()

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 227 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, and ns3::Node::ProtocolHandlerEntry::protocol.

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

UnregisterDeviceAdditionListener()

void ns3::Node::UnregisterDeviceAdditionListener

(

DeviceAdditionListener

listener

)

Parameters

listener

the listener to remove

Remove an existing listener from the list of listeners for the device-added event.

Definition at line 345 of file node.cc.

References m_deviceAdditionListeners, and NS_LOG_FUNCTION.

UnregisterProtocolHandler()

void ns3::Node::UnregisterProtocolHandler

(

ProtocolHandler

handler

)

Parameters

handler

the handler to unregister

After this call returns, the input handler will never be invoked anymore.

Definition at line 261 of file node.cc.

References m_handlers, and NS_LOG_FUNCTION.

Referenced by ns3::PacketSocket::Close().

Member Data Documentation

m_applications

std::vector<Ptr<Application> > ns3::Node::m_applications

private

Applications associated to this node.

Definition at line 288 of file node.h.

Referenced by AddApplication(), DoDispose(), DoInitialize(), GetApplication(), GetNApplications(), and GetTypeId().

m_deviceAdditionListeners

DeviceAdditionListenerList ns3::Node::m_deviceAdditionListeners

private

Device addition listeners in the node.

Definition at line 290 of file node.h.

Referenced by DoDispose(), NotifyDeviceAdded(), RegisterDeviceAdditionListener(), and UnregisterDeviceAdditionListener().

m_devices

std::vector<Ptr<NetDevice> > ns3::Node::m_devices

private

Devices associated to this node.

Definition at line 287 of file node.h.

Referenced by AddDevice(), DoDispose(), DoInitialize(), GetDevice(), GetNDevices(), GetTypeId(), RegisterDeviceAdditionListener(), and RegisterProtocolHandler().

m_handlers

ProtocolHandlerList ns3::Node::m_handlers

private

Protocol handlers in the node.

Definition at line 289 of file node.h.

Referenced by DoDispose(), ReceiveFromDevice(), RegisterProtocolHandler(), and UnregisterProtocolHandler().

m_id

uint32_t ns3::Node::m_id

private

Node id for this node.

Definition at line 285 of file node.h.

Referenced by Construct(), GetId(), and GetTypeId().

m_sid

uint32_t ns3::Node::m_sid

private

System id for this node.

Definition at line 286 of file node.h.

Referenced by GetSystemId(), and GetTypeId().

---

The documentation for this class was generated from the following files:

• src/network/model/node.h
• src/network/model/node.cc