A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::Ipv4Address Class Reference
Network » Address

Ipv4 addresses are stored in host order in this class. More...

#include "ipv4-address.h"

Collaboration diagram for ns3::Ipv4Address:

Public Member Functions

 Ipv4Address ()=default
 Ipv4Address (const char *address)
 Constructs an Ipv4Address by parsing a the input C-string.
 Ipv4Address (uint32_t address)
 input address is in host order.
Ipv4Address CombineMask (const Ipv4Mask &mask) const
 Combine this address with a network mask.
Address ConvertTo () const
 Convert to an Address type.
uint32_t Get () const
 Get the host-order 32-bit IP address.
Ipv4Address GetSubnetDirectedBroadcast (const Ipv4Mask &mask) const
 Generate subnet-directed broadcast address corresponding to mask.
bool IsAny () const
bool IsBroadcast () const
bool IsInitialized () const
bool IsLinkLocal () const
 If the IPv4 address is an APIPA address (169.254/16).
bool IsLocalhost () const
bool IsLocalMulticast () const
bool IsMulticast () const
bool IsSubnetDirectedBroadcast (const Ipv4Mask &mask) const
 Generate subnet-directed broadcast address corresponding to mask.
 operator Address () const
 Convert an instance of this class to a polymorphic Address instance.
std::strong_ordering operator<=> (const Ipv4Address &other) const =default
 Three-way comparison operator.
void Print (std::ostream &os) const
 Print this address to the given output stream.
void Serialize (uint8_t buf[4]) const
 Serialize this address to a 4-byte buffer.
void Set (const char *address)
 Sets an Ipv4Address by parsing a the input C-string.
void Set (uint32_t address)
 input address is in host order.

Static Public Member Functions

static bool CheckCompatible (const std::string &addressStr)
 Checks if the string contains an Ipv4Address.
static Ipv4Address ConvertFrom (const Address &address)
static Ipv4Address Deserialize (const uint8_t buf[4])
static Ipv4Address GetAny ()
static Ipv4Address GetBroadcast ()
static Ipv4Address GetLoopback ()
static Ipv4Address GetZero ()
static bool IsMatchingType (const Address &address)

Static Private Member Functions

static uint8_t GetType ()
 Get the underlying address type (automatically assigned).

Private Attributes

uint32_t m_address {0}
 IPv4 address.

Detailed Description

Ipv4 addresses are stored in host order in this class.

See also
Ipv4Address Attribute

Definition at line 32 of file ipv4-address.h.

Constructor & Destructor Documentation

◆ Ipv4Address() [1/3]

ns3::Ipv4Address::Ipv4Address ( )
default

References Ipv4Address(), CombineMask(), ConvertFrom(), ConvertTo(), GetAny(), GetBroadcast(), GetLoopback(), GetSubnetDirectedBroadcast(), GetZero(), IsAny(), IsBroadcast(), IsInitialized(), IsLinkLocal(), IsLocalhost(), IsLocalMulticast(), IsMatchingType(), IsMulticast(), and IsSubnetDirectedBroadcast().

Referenced by Ipv4Address(), CombineMask(), Deserialize(), GetAny(), GetBroadcast(), GetLoopback(), GetSubnetDirectedBroadcast(), GetZero(), and operator<=>().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Ipv4Address() [2/3]

ns3::Ipv4Address::Ipv4Address ( uint32_t address)
explicit

input address is in host order.

Parameters
addressThe host order 32-bit address

Definition at line 134 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

◆ Ipv4Address() [3/3]

ns3::Ipv4Address::Ipv4Address ( const char * address)

Constructs an Ipv4Address by parsing a the input C-string.

Input address is in format: hhh.xxx.xxx.lll where h is the high byte and l the low byte

Parameters
addressC-string containing the address as described above

Definition at line 140 of file ipv4-address.cc.

References m_address, NS_ABORT_MSG, and NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckCompatible()

bool ns3::Ipv4Address::CheckCompatible ( const std::string & addressStr)
static

Checks if the string contains an Ipv4Address.

Input address is in format: hhh.xxx.xxx.lll where h is the high byte and l the low byte

Note: the function uses inet_pton internally.

See also
Address::CheckCompatible hich has a similar name but which instead checks the underlying type and Length embedded in the Address.
Parameters
addressStrstring containing the address as described above
Returns
true if the string can be parsed as an IPv4 address

Definition at line 153 of file ipv4-address.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ CombineMask()

Ipv4Address ns3::Ipv4Address::CombineMask ( const Ipv4Mask & mask) const

Combine this address with a network mask.

This method returns an IPv4 address that is this address combined (bitwise and) with a network mask, yielding an IPv4 network address.

Parameters
maska network mask
Returns
the address combined with the mask

Definition at line 194 of file ipv4-address.cc.

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

Referenced by Ipv4Address(), ns3::Rip::DoSendRouteUpdate(), ns3::Rip::HandleRequests(), ns3::Rip::HandleResponses(), ns3::Ipv4InterfaceAddress::IsInSameSubnet(), ns3::Ipv4AddressGeneratorImpl::IsNetworkAllocated(), ns3::Ipv4L3ClickProtocol::LocalDeliver(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::Ipv4EndPointDemux::Lookup(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), ns3::Ipv4L3ClickProtocol::SelectSourceAddress(), ns3::Ipv4L3Protocol::SelectSourceAddress(), ns3::Ipv4L3Protocol::Send(), ns3::Ipv4L3ClickProtocol::SourceAddressSelection(), ns3::Ipv4L3Protocol::SourceAddressSelection(), ns3::GlobalRouteManagerImpl::SPFAddASExternal(), ns3::GlobalRouteManagerImpl::SPFIntraAddStub(), and ns3::GlobalRouteManagerImpl::SPFIntraAddTransit().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConvertFrom()

Ipv4Address ns3::Ipv4Address::ConvertFrom ( const Address & address)
static
Parameters
addressa polymorphic address
Returns
a new Ipv4Address from the polymorphic address

This function performs a type check and asserts if the type of the input address is not compatible with an Ipv4Address.

Definition at line 338 of file ipv4-address.cc.

References Deserialize(), GetType(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by Ipv4Address(), ns3::addressUtils::ConvertToSocketAddress(), PingTestCase::DoRun(), ns3::UdpSocketImpl::DoSend(), ns3::UdpSocketImpl::GetPeerName(), ns3::addressUtils::IsMulticast(), ns3::PbbAddressBlockIpv4::PrintAddress(), ns3::PbbMessageIpv4::PrintOriginatorAddress(), ns3::Ping::PrintReport(), ns3::Ping::Send(), ns3::TcpL4Protocol::SendPacket(), ns3::PbbAddressBlockIpv4::SerializeAddress(), ns3::PbbMessageIpv4::SerializeOriginatorAddress(), and ns3::Ping::StartApplication().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConvertTo()

Address ns3::Ipv4Address::ConvertTo ( ) const

Convert to an Address type.

Returns
the Address corresponding to this object.

Definition at line 329 of file ipv4-address.cc.

References GetType(), NS_LOG_FUNCTION, and Serialize().

Referenced by Ipv4Address(), and operator Address().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Deserialize()

Ipv4Address ns3::Ipv4Address::Deserialize ( const uint8_t buf[4])
static
Parameters
bufbuffer to read address from
Returns
an Ipv4Address

The input address is expected to be in network byte order format.

Definition at line 291 of file ipv4-address.cc.

References Ipv4Address(), and NS_LOG_FUNCTION.

Referenced by ns3::InetSocketAddress::ConvertFrom(), ConvertFrom(), ns3::dsr::DsrOptionRrepHeader::Deserialize(), ns3::dsr::DsrOptionRreqHeader::Deserialize(), ns3::dsr::DsrOptionSRHeader::Deserialize(), ns3::Ipv4FlowProbeTag::Deserialize(), ns3::Ipv4PacketInfoTag::Deserialize(), ns3::PbbAddressBlockIpv4::DeserializeAddress(), ns3::PbbMessageIpv4::DeserializeOriginatorAddress(), and ns3::Ipv6Address::GetIpv4MappedAddress().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Get()

uint32_t ns3::Ipv4Address::Get ( ) const

Get the host-order 32-bit IP address.

Returns
the host-order 32-bit IP address

Definition at line 168 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::DhcpServer::AddStaticDhcpEntry(), ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::Ipv4L3Protocol::BuildHeader(), ns3::EpcTftClassifier::Classify(), CombineMask(), ns3::Ipv4L3Protocol::DecreaseIdentification(), SwitchFlowTableTestCase::DoRun(), GetSubnetDirectedBroadcast(), ns3::Ipv4AddressGeneratorImpl::Init(), ns3::Ipv4AddressGeneratorImpl::InitAddress(), ns3::DhcpHelper::InstallDhcpServer(), ns3::DhcpHelper::InstallFixedAddress(), ns3::Ipv4Mask::IsMatch(), IsSubnetDirectedBroadcast(), ns3::Ipv4L3Protocol::ProcessFragment(), ns3::GtpcIes::SerializeFteid(), ns3::Ipv4AddressHelper::SetBase(), ns3::GlobalRouteManagerImpl::SPFIntraAddStub(), and ns3::WriteTo().

Here is the caller graph for this function:

◆ GetAny()

Ipv4Address ns3::Ipv4Address::GetAny ( )
static
Returns
the 0.0.0.0 address Caller graph was not generated because of its size.

Definition at line 364 of file ipv4-address.cc.

References Ipv4Address(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::DhcpClient::DhcpClient(), ns3::DhcpClient::DhcpClient(), Ipv4Address(), ns3::Ipv4RawSocketImpl::Ipv4RawSocketImpl(), Tunnel::Tunnel(), ns3::Ipv4EndPointDemux::Allocate(), ns3::Ipv4EndPointDemux::Allocate(), ns3::Ipv4RawSocketImpl::Bind(), ns3::TcpSocketBase::Bind(), ns3::UdpSocketImpl::Bind(), BuildAppsTest(), BuildAppsTest(), Bug772ChainTest::CreateDevices(), ChainRegressionTest::CreateDevices(), ns3::olsr::Bug780Test::CreateNodes(), ns3::olsr::RoutingProtocol::DoInitialize(), BriteTopologyFunctionTestCase::DoRun(), BulkSendBasicTestCase::DoRun(), BulkSendSeqTsSizeTestCase::DoRun(), CsmaBridgeTestCase::DoRun(), CsmaBroadcastTestCase::DoRun(), CsmaMulticastTestCase::DoRun(), CsmaOneSubnetTestCase::DoRun(), CsmaStarTestCase::DoRun(), DualStackTestCase::DoRun(), EpcS1uDlTestCase::DoRun(), EpcS1uUlTestCase::DoRun(), IcmpEchoReplyTestCase::DoRun(), IcmpTimeExceedTestCase::DoRun(), Ipv4DeduplicationPerformanceTest::DoRun(), Ipv4DeduplicationTest::DoRun(), Ipv4DynamicGlobalRoutingTestCase::DoRun(), Ipv4PacketInfoTagTest::DoRun(), Ipv4RawFragmentationTest::DoRun(), LenaCqaFfMacSchedulerTestCase1::DoRun(), LenaCqaFfMacSchedulerTestCase2::DoRun(), LenaFdTbfqFfMacSchedulerTestCase1::DoRun(), LenaFdTbfqFfMacSchedulerTestCase2::DoRun(), LenaPssFfMacSchedulerTestCase1::DoRun(), LenaPssFfMacSchedulerTestCase2::DoRun(), LenaTdTbfqFfMacSchedulerTestCase1::DoRun(), LenaTdTbfqFfMacSchedulerTestCase2::DoRun(), LteDistributedFfrAreaTestCase::DoRun(), LteEpcE2eDataTestCase::DoRun(), LteRadioLinkFailureTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), ns3::LenaDeactivateBearerTestCase::DoRun(), ns3::TcpGeneralTest::DoRun(), Ns3TcpCubicTestCase::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpNoDelayTestCase::DoRun(), Ns3TcpSocketTestCaseCsma::DoRun(), Ns3TcpSocketTestCaseP2P::DoRun(), Ns3TcpStateTestCase::DoRun(), TcpEndPointBug2211Test::DoRun(), UdpEchoClientSetFillTestCase::DoRun(), UdpSocketLoopbackTest::DoRun(), UdpTraceClientServerTestCase::DoRun(), WifiAcMappingTest::DoRun(), WifiMsduAggregatorThroughputTest::DoRun(), ns3::Rip::DoSendRouteUpdate(), ns3::UdpSocketImpl::DoSendTo(), ns3::PacketSink::DoStartApplication(), ns3::UdpEchoServer::DoStartApplication(), ns3::UdpServer::DoStartApplication(), experiment(), ns3::Ipv4RawSocketImpl::ForwardUp(), ns3::Ipv4RawSocketImpl::GetPeerName(), ns3::Rip::HandleRequests(), FlameRegressionTest::InstallApplications(), HwmpDoRfRegressionTest::InstallApplications(), HwmpProactiveRegressionTest::InstallApplications(), HwmpReactiveRegressionTest::InstallApplications(), HwmpSimplestRegressionTest::InstallApplications(), InstallPacketSink(), ns3::Ipv4L3Protocol::IpMulticastForward(), ns3::Ipv4EndPointDemux::Lookup(), ns3::dsdv::RoutingProtocol::NotifyAddAddress(), ns3::NoBackhaulEpcHelper::NotifyConstructionCompleted(), ns3::dsdv::RoutingProtocol::NotifyInterfaceUp(), ns3::dsdv::RoutingProtocol::NotifyRemoveAddress(), anonymous_namespace{wifi-mixed-network.cc}::Experiment::Run(), NeighborCacheExample::Run(), ns3::Ipv4L3Protocol::Send(), ns3::Rip::SendRouteRequest(), ns3::Ipv4RawSocketImpl::SendTo(), TcpTestCase::SetupDefaultSim(), anonymous_namespace{wifi-clear-channel-cmu.cc}::Experiment::SetupPacketReceive(), anonymous_namespace{wifi-multirate.cc}::Experiment::SetupPacketReceive(), ns3::Ipv4EndPointDemux::SimpleLookup(), ns3::DhcpClient::StartApplication(), ns3::DhcpServer::StartApplication(), ns3::V4TraceRoute::StartApplication(), Receiver::StartApplication(), and Ipv4FragmentationTest::StartServer().

Here is the call graph for this function:

◆ GetBroadcast()

Ipv4Address ns3::Ipv4Address::GetBroadcast ( )
static
Returns
the 255.255.255.255 address

Definition at line 372 of file ipv4-address.cc.

References Ipv4Address(), and NS_LOG_FUNCTION_NOARGS.

Referenced by Ipv4Address(), PingTestSuite::PingTestSuite(), IsSubnetDirectedBroadcast(), ns3::ArpL3Protocol::SendArpRequest(), Ipv4FragmentationTest::SendClient(), and ns3::aodv::RoutingProtocol::SendRerrMessage().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetLoopback()

Ipv4Address ns3::Ipv4Address::GetLoopback ( )
static
Returns
the 127.0.0.1 address

Definition at line 380 of file ipv4-address.cc.

References Ipv4Address(), and NS_LOG_FUNCTION_NOARGS.

Referenced by Ipv4Address(), ns3::Ipv4InterfaceAddress::Ipv4InterfaceAddress(), Ipv4L3ProtocolTestCase::DoRun(), ns3::aodv::LoopbackTestCase::DoRun(), TcpEndPointBug2211Test::DoRun(), TcpSynConnectionFailedTest::DoRun(), ns3::Ipv4Interface::RemoveAddress(), ns3::Ipv4L3ClickProtocol::RemoveAddress(), ns3::Ipv4L3Protocol::RemoveAddress(), ns3::aodv::LoopbackTestCase::SendData(), ns3::aodv::RoutingProtocol::SetIpv4(), ns3::dsdv::RoutingProtocol::SetIpv4(), ns3::Ipv4L3ClickProtocol::SetupLoopback(), and ns3::Ipv4L3Protocol::SetupLoopback().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetSubnetDirectedBroadcast()

Ipv4Address ns3::Ipv4Address::GetSubnetDirectedBroadcast ( const Ipv4Mask & mask) const

Generate subnet-directed broadcast address corresponding to mask.

The subnet-directed broadcast address has the host bits set to all ones. If this method is called with a mask of 255.255.255.255, (i.e., the address is a /32 address), the program will assert, since there is no subnet associated with a /32 address.

Parameters
maska network mask
Returns
a broadcast address for the subnet.

Definition at line 201 of file ipv4-address.cc.

References Ipv4Address(), Get(), ns3::Ipv4Mask::GetInverse(), ns3::Ipv4Mask::GetOnes(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by Ipv4Address(), ns3::Ipv4FlowProbe::DropLogger(), and ns3::olsr::RoutingProtocol::SendPacket().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetType()

uint8_t ns3::Ipv4Address::GetType ( )
staticprivate

Get the underlying address type (automatically assigned).

Returns
the address type

Definition at line 348 of file ipv4-address.cc.

References NS_LOG_FUNCTION_NOARGS, and ns3::Address::Register().

Referenced by ConvertFrom(), ConvertTo(), IsMatchingType(), and operator<=>().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetZero()

Ipv4Address ns3::Ipv4Address::GetZero ( )
static
Returns
the 0.0.0.0 address

Definition at line 356 of file ipv4-address.cc.

References Ipv4Address(), and NS_LOG_FUNCTION_NOARGS.

Referenced by Ipv4Address(), ns3::TapFdNetDeviceHelper::TapFdNetDeviceHelper(), ns3::Ipv4RoutingTableEntry::CreateDefaultRoute(), ns3::TapFdNetDeviceHelper::CreateFileDescriptor(), ns3::Ipv4FlowClassifier::FindFlow(), ns3::TcpSocketBase::GetSockName(), ns3::UdpSocketImpl::GetSockName(), ns3::Ipv4RoutingTableEntry::IsDefault(), ns3::Ipv4RoutingTableEntry::IsGateway(), ns3::Rip::Lookup(), ns3::Ipv4StaticRouting::LookupStatic(), ns3::TcpSocketBase::RecvFrom(), and ns3::GlobalRouteManagerImpl::SPFNexthopCalculation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsAny()

bool ns3::Ipv4Address::IsAny ( ) const
Returns
true if address is 0.0.0.0; false otherwise

Definition at line 233 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by Ipv4Address(), ns3::Rip::Lookup(), and ns3::Ipv4L3Protocol::Send().

Here is the caller graph for this function:

◆ IsBroadcast()

bool ns3::Ipv4Address::IsBroadcast ( ) const
Returns
true if address is 255.255.255.255; false otherwise

Definition at line 247 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by Ipv4Address(), ns3::UdpSocketImpl::DoSendTo(), ns3::Ipv4L3Protocol::IsUnicast(), ns3::Ipv4L3ClickProtocol::LocalDeliver(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::dsr::DsrRouteCache::RebuildBestRouteTable(), ns3::dsr::DsrRouting::Receive(), ns3::Icmpv4L4Protocol::Receive(), ns3::aodv::RoutingProtocol::RouteInput(), ns3::dsdv::RoutingProtocol::RouteInput(), ns3::Rip::RouteInput(), ns3::Ipv4Interface::Send(), ns3::Ipv4L3Protocol::Send(), and ns3::Ping::StartApplication().

Here is the caller graph for this function:

◆ IsInitialized()

bool ns3::Ipv4Address::IsInitialized ( ) const
Returns
true if address is initialized (i.e., set to something), false otherwise
Deprecated
"Deprecated in ns-3.47: " "Use IsAny or std::optional"

Definition at line 226 of file ipv4-address.cc.

References NS_LOG_FUNCTION.

Referenced by Ipv4Address().

Here is the caller graph for this function:

◆ IsLinkLocal()

bool ns3::Ipv4Address::IsLinkLocal ( ) const

If the IPv4 address is an APIPA address (169.254/16).

The Automatic Private IP Address is described in RFC 3927

Returns
true if the address is link-local, false otherwise

Definition at line 273 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by Ipv4Address().

Here is the caller graph for this function:

◆ IsLocalhost()

bool ns3::Ipv4Address::IsLocalhost ( ) const
Returns
true if address is 127.0.0.1; false otherwise

Definition at line 240 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by Ipv4Address().

Here is the caller graph for this function:

◆ IsLocalMulticast()

bool ns3::Ipv4Address::IsLocalMulticast ( ) const
Returns
true only if address is in local multicast address scope, 224.0.0.0/24

Definition at line 265 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by Ipv4Address(), ns3::Rip::Lookup(), ns3::Ipv4StaticRouting::LookupStatic(), and ns3::Ipv4L3Protocol::Send().

Here is the caller graph for this function:

◆ IsMatchingType()

bool ns3::Ipv4Address::IsMatchingType ( const Address & address)
static
Parameters
addressan address to compare type with
Returns
true if the type of the address stored internally is compatible with the type of the input address, false otherwise.

Definition at line 316 of file ipv4-address.cc.

References GetType(), and NS_LOG_FUNCTION.

Referenced by Ipv4Address(), ns3::TcpHeader::CalculateHeaderChecksum(), ns3::UdpHeader::CalculateHeaderChecksum(), ns3::addressUtils::ConvertToSocketAddress(), ns3::UdpSocketImpl::DoSend(), ns3::UdpSocketImpl::GetPeerName(), ns3::addressUtils::IsMulticast(), ns3::Ping::PrintReport(), ns3::TcpL4Protocol::SendPacket(), ns3::ThreeGppHttpClient::SetPort(), ns3::ThreeGppHttpServer::SetPort(), ns3::UdpClient::SetPort(), ns3::UdpEchoClient::SetPort(), ns3::UdpTraceClient::SetPort(), and ns3::Ping::StartApplication().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsMulticast()

bool ns3::Ipv4Address::IsMulticast ( ) const
Returns
true only if address is in the range 224.0.0.0 - 239.255.255.255

Definition at line 254 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by Ipv4Address(), ns3::dsr::DsrOptionRerr::DoSendError(), ns3::UdpSocketImpl::DoSendTo(), ns3::Ipv4L3Protocol::IsUnicast(), ns3::Ipv4L3Protocol::IsUnicast(), ns3::Ipv4L3ClickProtocol::LocalDeliver(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::dsr::DsrOptionSR::Process(), ns3::dsr::DsrRouting::Receive(), ns3::Ipv4L3Protocol::Receive(), ns3::aodv::RoutingProtocol::RouteInput(), ns3::dsdv::RoutingProtocol::RouteInput(), ns3::Ipv4ListRouting::RouteInput(), ns3::Ipv4StaticRouting::RouteInput(), ns3::Rip::RouteInput(), ns3::Ipv4GlobalRouting::RouteOutput(), ns3::Ipv4StaticRouting::RouteOutput(), ns3::Rip::RouteOutput(), ns3::Ipv4Interface::Send(), ns3::Ipv4L3Protocol::Send(), and ns3::Ping::StartApplication().

Here is the caller graph for this function:

◆ IsSubnetDirectedBroadcast()

bool ns3::Ipv4Address::IsSubnetDirectedBroadcast ( const Ipv4Mask & mask) const

Generate subnet-directed broadcast address corresponding to mask.

The subnet-directed broadcast address has the host bits set to all ones. If this method is called with a mask of 255.255.255.255, (i.e., the address is a /32 address), the program will assert, since there is no subnet associated with a /32 address.

Parameters
maska network mask
Returns
true if the address, when combined with the input mask, has all of its host bits set to one

Definition at line 213 of file ipv4-address.cc.

References Get(), ns3::Ipv4Mask::Get(), GetBroadcast(), ns3::Ipv4Mask::GetOnes(), and NS_LOG_FUNCTION.

Referenced by Ipv4Address(), ns3::Ipv4L3Protocol::IsUnicast(), ns3::Ipv4L3ClickProtocol::LocalDeliver(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::Ipv4Interface::Send(), and ns3::Ipv4L3Protocol::Send().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator Address()

ns3::Ipv4Address::operator Address ( ) const

Convert an instance of this class to a polymorphic Address instance.

Returns
a new Address instance

Definition at line 322 of file ipv4-address.cc.

References ConvertTo().

Here is the call graph for this function:

◆ operator<=>()

std::strong_ordering ns3::Ipv4Address::operator<=> ( const Ipv4Address & other) const
default

Three-way comparison operator.

Parameters
otherthe other address to compare with
Returns
comparison result

References Ipv4Address(), GetType(), and private.

Here is the call graph for this function:

◆ Print()

void ns3::Ipv4Address::Print ( std::ostream & os) const

Print this address to the given output stream.

The print format is in the typical "192.168.1.1"

Parameters
osThe output stream to which this Ipv4Address is printed

Definition at line 308 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::PbbAddressBlockIpv4::PrintAddress(), ns3::PbbMessageIpv4::PrintOriginatorAddress(), and ns3::Ipv4ClickRouting::RouteOutput().

Here is the caller graph for this function:

◆ Serialize()

void ns3::Ipv4Address::Serialize ( uint8_t buf[4]) const

Serialize this address to a 4-byte buffer.

Parameters
bufoutput buffer to which this address gets overwritten with this Ipv4Address

Definition at line 281 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by ConvertTo(), ns3::Mac48Address::GetMulticast(), ns3::ArpQueueDiscItem::Hash(), ns3::Ipv4QueueDiscItem::Hash(), ns3::Ipv6Address::MakeIpv4MappedAddress(), ns3::PbbAddressBlockIpv4::SerializeAddress(), and ns3::PbbMessageIpv4::SerializeOriginatorAddress().

Here is the caller graph for this function:

◆ Set() [1/2]

void ns3::Ipv4Address::Set ( const char * address)

Sets an Ipv4Address by parsing a the input C-string.

Input address is in format: hhh.xxx.xxx.lll where h is the high byte and l the low byte

Parameters
addressC-string containing the address as described above

Definition at line 182 of file ipv4-address.cc.

References m_address, NS_ABORT_MSG, and NS_LOG_FUNCTION.

◆ Set() [2/2]

void ns3::Ipv4Address::Set ( uint32_t address)

input address is in host order.

Parameters
addressThe host order 32-bit address

Definition at line 175 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by EpcTftClassifierTestSuite::EpcTftClassifierTestSuite(), ns3::GtpcIes::DeserializeFteid(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), and ns3::ReadFrom().

Here is the caller graph for this function:

Member Data Documentation

◆ m_address

uint32_t ns3::Ipv4Address::m_address {0}
private

IPv4 address.

Definition at line 242 of file ipv4-address.h.

Referenced by Ipv4Address(), Ipv4Address(), Get(), IsAny(), IsBroadcast(), IsLinkLocal(), IsLocalhost(), IsLocalMulticast(), IsMulticast(), Print(), Serialize(), Set(), and Set().

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