A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
ns3::Ipv4InterfaceAddress Class Reference
Address

a class to store IPv4 address information on an interface More...

#include <ipv4-interface-address.h>

+ Collaboration diagram for ns3::Ipv4InterfaceAddress:

Public Types

enum  InterfaceAddressScope_e { HOST, LINK, GLOBAL }

Public Member Functions

 Ipv4InterfaceAddress ()
 Ipv4InterfaceAddress (Ipv4Address local, Ipv4Mask mask)
 Ipv4InterfaceAddress (const Ipv4InterfaceAddress &o)
Ipv4Address GetBroadcast (void) const
Ipv4Address GetLocal (void) const
Ipv4Mask GetMask (void) const
Ipv4InterfaceAddress::InterfaceAddressScope_e GetScope (void) const
bool IsSecondary (void) const
void SetBroadcast (Ipv4Address broadcast)
void SetLocal (Ipv4Address local)
void SetMask (Ipv4Mask mask)
void SetPrimary (void)
void SetScope (Ipv4InterfaceAddress::InterfaceAddressScope_e scope)
void SetSecondary (void)

Private Attributes

Ipv4Address m_broadcast
Ipv4Address m_local
Ipv4Mask m_mask
InterfaceAddressScope_e m_scope
bool m_secondary

Friends

bool operator!= (Ipv4InterfaceAddress const &a, Ipv4InterfaceAddress const &b)
bool operator== (Ipv4InterfaceAddress const &a, Ipv4InterfaceAddress const &b)

Detailed Description

a class to store IPv4 address information on an interface

Corresponds to Linux struct in_ifaddr. A list of these addresses is stored in Ipv4Interface. This class is modelled after how current Linux handles IP aliasing for IPv4. Notably, aliasing of IPv4 interfaces (e.g., "eth0:1") is not used, and instead an interface is assigned possibly multiple addresses, with each address being classified as being primary and secondary. See the iproute2 documentation for this distinction.

Definition at line 42 of file ipv4-interface-address.h.

Member Enumeration Documentation

enum ns3::Ipv4InterfaceAddress::InterfaceAddressScope_e
Enumerator:
HOST 
LINK 
GLOBAL 

Definition at line 45 of file ipv4-interface-address.h.

Constructor & Destructor Documentation

ns3::Ipv4InterfaceAddress::Ipv4InterfaceAddress ( )

Definition at line 29 of file ipv4-interface-address.cc.

References NS_LOG_FUNCTION.

ns3::Ipv4InterfaceAddress::Ipv4InterfaceAddress ( Ipv4Address  local,
Ipv4Mask  mask 
)

Definition at line 36 of file ipv4-interface-address.cc.

References ns3::Ipv4Address::Get(), ns3::Ipv4Mask::Get(), m_broadcast, m_local, m_mask, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

ns3::Ipv4InterfaceAddress::Ipv4InterfaceAddress ( const Ipv4InterfaceAddress &  o)

Definition at line 46 of file ipv4-interface-address.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Ipv4Address ns3::Ipv4InterfaceAddress::GetBroadcast ( void  ) const

Definition at line 92 of file ipv4-interface-address.cc.

References m_broadcast, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::DsdvTableTestCase::DoRun(), ns3::UdpSocketImpl::DoSendTo(), ns3::Ipv4L3Protocol::IsDestinationAddress(), ns3::aodv::RoutingProtocol::NotifyAddAddress(), ns3::dsdv::RoutingProtocol::NotifyAddAddress(), ns3::aodv::RoutingProtocol::NotifyInterfaceUp(), ns3::aodv::RoutingProtocol::NotifyRemoveAddress(), ns3::operator<<(), ns3::aodv::RoutingProtocol::RecvRequest(), ns3::aodv::RoutingProtocol::RouteInput(), ns3::dsdv::RoutingProtocol::RouteInput(), ns3::Ipv4StaticRouting::RouteInput(), ns3::Ipv4GlobalRouting::RouteInput(), ns3::aodv::RoutingProtocol::SendHello(), ns3::dsdv::RoutingProtocol::SendPeriodicUpdate(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), ns3::dsdv::RoutingProtocol::SendTriggeredUpdate(), and ns3::dsr::DsrRouting::Start().

+ Here is the caller graph for this function:

Ipv4Address ns3::Ipv4InterfaceAddress::GetLocal ( void  ) const

Definition at line 64 of file ipv4-interface-address.cc.

References m_local, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::EpcHelper::ActivateEpsBearer(), ns3::olsr::RoutingProtocol::AddEntry(), ns3::NscTcpL4Protocol::AddInterface(), ns3::GlobalRouter::BuildNetworkLSAs(), ns3::Ipv4NixVectorRouting::BuildNixVectorLocal(), ns3::TapBridge::CreateTap(), StaticRoutingSlash32TestCase::DoRun(), ns3::DsdvTableTestCase::DoRun(), GlobalRoutingSlash32TestCase::DoRun(), ns3::UdpSocketImpl::DoSendTo(), ns3::olsr::RoutingProtocol::DoStart(), ns3::Ipv4NixVectorRouting::FindNetDeviceForNixIndex(), ns3::Ipv4InterfaceContainer::GetAddress(), ns3::dsr::DsrRouting::GetIDfromIP(), ns3::dsr::DsrOptions::GetIDfromIP(), ns3::dsr::DsrRouting::GetIPfromID(), ns3::dsr::DsrRouting::GetIPfromMAC(), ns3::AnimationInterface::GetIpv4Address(), ns3::Ipv4L3Protocol::IsDestinationAddress(), ns3::aodv::RoutingProtocol::IsMyOwnAddress(), ns3::olsr::RoutingProtocol::IsMyOwnAddress(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::Ipv4EndPointDemux::Lookup(), ns3::aodv::RoutingProtocol::NotifyAddAddress(), ns3::dsdv::RoutingProtocol::NotifyAddAddress(), ns3::Ipv4StaticRouting::NotifyAddAddress(), ns3::aodv::RoutingProtocol::NotifyInterfaceDown(), ns3::aodv::RoutingProtocol::NotifyInterfaceUp(), ns3::dsdv::RoutingProtocol::NotifyInterfaceUp(), ns3::Ipv4StaticRouting::NotifyInterfaceUp(), ns3::aodv::RoutingProtocol::NotifyRemoveAddress(), ns3::Ipv4StaticRouting::NotifyRemoveAddress(), ns3::operator<<(), ns3::aodv::RoutingTableEntry::Print(), ns3::dsdv::RoutingTableEntry::Print(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessPointToPointLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), ns3::aodv::RoutingProtocol::RouteInput(), ns3::dsdv::RoutingProtocol::RouteInput(), ns3::Ipv4StaticRouting::RouteInput(), ns3::Ipv4GlobalRouting::RouteInput(), ns3::Ipv4NixVectorRouting::RouteInput(), ns3::olsr::RoutingProtocol::RouteInput(), ns3::Ipv4NixVectorRouting::RouteOutput(), ns3::olsr::RoutingProtocol::RouteOutput(), ns3::dsdv::RoutingTableEntry::RoutingTableEntry(), ns3::aodv::RoutingTableEntry::RoutingTableEntry(), ns3::Ipv4L3Protocol::SelectSourceAddress(), ns3::Ipv4L3Protocol::Send(), ns3::aodv::RoutingProtocol::SendHello(), ns3::olsr::RoutingProtocol::SendMid(), ns3::dsdv::RoutingProtocol::SendPeriodicUpdate(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::aodv::RoutingProtocol::SendRerrMessage(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), ns3::dsdv::RoutingProtocol::SendTriggeredUpdate(), ns3::aodv::RoutingProtocol::SetIpv4(), ns3::dsdv::RoutingProtocol::SetIpv4(), ns3::olsr::RoutingProtocol::SetMainInterface(), ns3::Ipv4StaticRouting::SourceAddressSelection(), and ns3::dsr::DsrRouting::Start().

Ipv4Mask ns3::Ipv4InterfaceAddress::GetMask ( void  ) const

Definition at line 78 of file ipv4-interface-address.cc.

References m_mask, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::NscTcpL4Protocol::AddInterface(), ns3::GlobalRouter::BuildNetworkLSAs(), ns3::TapBridge::CreateTap(), ns3::UdpSocketImpl::DoSendTo(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::Ipv4EndPointDemux::Lookup(), ns3::Ipv4StaticRouting::NotifyAddAddress(), ns3::Ipv4StaticRouting::NotifyInterfaceUp(), ns3::Ipv4StaticRouting::NotifyRemoveAddress(), ns3::operator<<(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessPointToPointLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), ns3::aodv::RoutingProtocol::RecvRequest(), ns3::Ipv4L3Protocol::SelectSourceAddress(), ns3::Ipv4L3Protocol::Send(), ns3::aodv::RoutingProtocol::SendHello(), ns3::dsdv::RoutingProtocol::SendPeriodicUpdate(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), ns3::dsdv::RoutingProtocol::SendTriggeredUpdate(), and ns3::Ipv4StaticRouting::SourceAddressSelection().

+ Here is the caller graph for this function:

Ipv4InterfaceAddress::InterfaceAddressScope_e ns3::Ipv4InterfaceAddress::GetScope ( void  ) const

Definition at line 106 of file ipv4-interface-address.cc.

References m_scope, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::operator<<(), and ns3::Ipv4L3Protocol::SelectSourceAddress().

+ Here is the caller graph for this function:

bool ns3::Ipv4InterfaceAddress::IsSecondary ( void  ) const

Definition at line 113 of file ipv4-interface-address.cc.

References m_secondary, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::operator<<(), ns3::Ipv4L3Protocol::SelectSourceAddress(), and ns3::Ipv4StaticRouting::SourceAddressSelection().

+ Here is the caller graph for this function:

void ns3::Ipv4InterfaceAddress::SetBroadcast ( Ipv4Address  broadcast)

Definition at line 85 of file ipv4-interface-address.cc.

References m_broadcast, and NS_LOG_FUNCTION_NOARGS.

void ns3::Ipv4InterfaceAddress::SetLocal ( Ipv4Address  local)

Definition at line 57 of file ipv4-interface-address.cc.

References m_local, and NS_LOG_FUNCTION_NOARGS.

void ns3::Ipv4InterfaceAddress::SetMask ( Ipv4Mask  mask)

Definition at line 71 of file ipv4-interface-address.cc.

References m_mask, and NS_LOG_FUNCTION_NOARGS.

void ns3::Ipv4InterfaceAddress::SetPrimary ( void  )

Definition at line 127 of file ipv4-interface-address.cc.

References m_secondary, and NS_LOG_FUNCTION_NOARGS.

void ns3::Ipv4InterfaceAddress::SetScope ( Ipv4InterfaceAddress::InterfaceAddressScope_e  scope)

Definition at line 99 of file ipv4-interface-address.cc.

References m_scope, and NS_LOG_FUNCTION_NOARGS.

void ns3::Ipv4InterfaceAddress::SetSecondary ( void  )

Definition at line 120 of file ipv4-interface-address.cc.

References m_secondary, and NS_LOG_FUNCTION_NOARGS.

Friends And Related Function Documentation

bool operator!= ( Ipv4InterfaceAddress const &  a,
Ipv4InterfaceAddress const &  b 
)
friend

Definition at line 92 of file ipv4-interface-address.h.

bool operator== ( Ipv4InterfaceAddress const &  a,
Ipv4InterfaceAddress const &  b 
)
friend

Definition at line 87 of file ipv4-interface-address.h.

Member Data Documentation

Ipv4Address ns3::Ipv4InterfaceAddress::m_broadcast
private

Definition at line 76 of file ipv4-interface-address.h.

Referenced by GetBroadcast(), Ipv4InterfaceAddress(), ns3::operator!=(), ns3::operator==(), and SetBroadcast().

Ipv4Address ns3::Ipv4InterfaceAddress::m_local
private

Definition at line 72 of file ipv4-interface-address.h.

Referenced by GetLocal(), Ipv4InterfaceAddress(), ns3::operator!=(), ns3::operator==(), and SetLocal().

Ipv4Mask ns3::Ipv4InterfaceAddress::m_mask
private

Definition at line 75 of file ipv4-interface-address.h.

Referenced by GetMask(), Ipv4InterfaceAddress(), ns3::operator!=(), ns3::operator==(), and SetMask().

InterfaceAddressScope_e ns3::Ipv4InterfaceAddress::m_scope
private

Definition at line 78 of file ipv4-interface-address.h.

Referenced by GetScope(), ns3::operator!=(), ns3::operator==(), and SetScope().

bool ns3::Ipv4InterfaceAddress::m_secondary
private

Definition at line 79 of file ipv4-interface-address.h.

Referenced by IsSecondary(), ns3::operator!=(), ns3::operator==(), SetPrimary(), and SetSecondary().

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