A Discrete-Event Network Simulator
API
ns3::Ipv4Address Class Reference

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

#include "ipv4-address.h"

Public Member Functions

 Ipv4Address ()
 
 Ipv4Address (uint32_t address)
 input address is in host order. More...
 
 Ipv4Address (char const *address)
 Constructs an Ipv4Address by parsing a the input C-string. More...
 
Ipv4Address CombineMask (Ipv4Mask const &mask) const
 Combine this address with a network mask. More...
 
uint32_t Get (void) const
 Get the host-order 32-bit IP address. More...
 
Ipv4Address GetSubnetDirectedBroadcast (Ipv4Mask const &mask) const
 Generate subnet-directed broadcast address corresponding to mask. More...
 
bool IsAny (void) const
 
bool IsBroadcast (void) const
 
bool IsEqual (const Ipv4Address &other) const
 Comparison operation between two Ipv4Addresses. More...
 
bool IsLocalhost (void) const
 
bool IsLocalMulticast (void) const
 
bool IsMulticast (void) const
 
bool IsSubnetDirectedBroadcast (Ipv4Mask const &mask) const
 Generate subnet-directed broadcast address corresponding to mask. More...
 
 operator Address () const
 Convert an instance of this class to a polymorphic Address instance. More...
 
void Print (std::ostream &os) const
 Print this address to the given output stream. More...
 
void Serialize (uint8_t buf[4]) const
 Serialize this address to a 4-byte buffer. More...
 
void Set (uint32_t address)
 input address is in host order. More...
 
void Set (char const *address)
 Sets an Ipv4Address by parsing a the input C-string. More...
 

Static Public Member Functions

static Ipv4Address ConvertFrom (const Address &address)
 
static Ipv4Address Deserialize (const uint8_t buf[4])
 
static Ipv4Address GetAny (void)
 
static Ipv4Address GetBroadcast (void)
 
static Ipv4Address GetLoopback (void)
 
static Ipv4Address GetZero (void)
 
static bool IsMatchingType (const Address &address)
 

Private Member Functions

Address ConvertTo (void) const
 Convert to an Address type. More...
 

Static Private Member Functions

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

Private Attributes

uint32_t m_address
 IPv4 address. More...
 

Friends

bool operator!= (Ipv4Address const &a, Ipv4Address const &b)
 Not equal to operator. More...
 
bool operator< (Ipv4Address const &a, Ipv4Address const &b)
 Less than to operator. More...
 
bool operator== (Ipv4Address const &a, Ipv4Address const &b)
 Equal to operator. More...
 

Detailed Description

Ipv4 addresses are stored in host order in this class.

See also
Ipv4Address Attribute

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

Constructor & Destructor Documentation

◆ Ipv4Address() [1/3]

ns3::Ipv4Address::Ipv4Address ( )

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

References NS_LOG_FUNCTION.

Referenced by CombineMask(), and GetSubnetDirectedBroadcast().

+ 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 206 of file ipv4-address.cc.

References first::address, m_address, and NS_LOG_FUNCTION.

◆ Ipv4Address() [3/3]

ns3::Ipv4Address::Ipv4Address ( char const *  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 211 of file ipv4-address.cc.

References first::address, ns3::AsciiToIpv4Host(), m_address, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Function Documentation

◆ CombineMask()

Ipv4Address ns3::Ipv4Address::CombineMask ( Ipv4Mask const &  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 237 of file ipv4-address.cc.

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

Referenced by ns3::IpcsClassifierRecord::CheckMatchDstAddr(), ns3::IpcsClassifierRecord::CheckMatchSrcAddr(), ns3::Rip::DoSendRouteUpdate(), ns3::Rip::HandleRequests(), ns3::Rip::HandleResponses(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::Ipv4EndPointDemux::Lookup(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), ns3::Ipv4L3Protocol::SelectSourceAddress(), ns3::Ipv4L3Protocol::Send(), 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()

◆ ConvertTo()

Address ns3::Ipv4Address::ConvertTo ( void  ) const
private

Convert to an Address type.

Returns
the Address corresponding to this object.

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

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

+ Here is the call graph for this function:

◆ Deserialize()

◆ Get()

◆ GetAny()

Ipv4Address ns3::Ipv4Address::GetAny ( void  )
static

◆ GetBroadcast()

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

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::aodv::RoutingProtocol::SendRerrMessage().

+ Here is the caller graph for this function:

◆ GetLoopback()

Ipv4Address ns3::Ipv4Address::GetLoopback ( void  )
static

◆ GetSubnetDirectedBroadcast()

Ipv4Address ns3::Ipv4Address::GetSubnetDirectedBroadcast ( Ipv4Mask const &  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 244 of file ipv4-address.cc.

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

Referenced by 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 ( void  )
staticprivate

Get the underlying address type (automatically assigned).

Returns
the address type

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

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

Referenced by ConvertFrom(), ConvertTo(), and IsMatchingType().

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

◆ GetZero()

◆ IsAny()

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

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

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::Rip::Lookup().

+ Here is the caller graph for this function:

◆ IsBroadcast()

◆ IsEqual()

bool ns3::Ipv4Address::IsEqual ( const Ipv4Address other) const
inline

Comparison operation between two Ipv4Addresses.

Parameters
otheraddress to which to compare this address
Returns
True if the addresses are equal. False otherwise.

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

References m_address.

Referenced by ns3::Ipv4RoutingTableEntry::IsDefault(), ns3::Ipv4RoutingTableEntry::IsGateway(), ns3::ArpL3Protocol::Receive(), and ns3::Ipv4L3Protocol::SendRealOut().

+ Here is the caller graph for this function:

◆ IsLocalhost()

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

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

References m_address, and NS_LOG_FUNCTION.

◆ IsLocalMulticast()

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

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

References m_address, and NS_LOG_FUNCTION.

Referenced by 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 343 of file ipv4-address.cc.

References first::address, GetType(), and NS_LOG_FUNCTION.

Referenced by ns3::UdpHeader::CalculateHeaderChecksum(), ns3::TcpHeader::CalculateHeaderChecksum(), ns3::UdpSocketImpl::DoSend(), ns3::UdpSocketImpl::GetPeerName(), ns3::ThreeGppHttpClient::OpenConnection(), ns3::UdpClient::Send(), ns3::UdpEchoClient::Send(), ns3::UdpTraceClient::SendPacket(), ns3::TcpL4Protocol::SendPacket(), ns3::UdpClient::StartApplication(), ns3::UdpTraceClient::StartApplication(), ns3::UdpEchoClient::StartApplication(), and ns3::ThreeGppHttpServer::StartApplication().

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

◆ IsMulticast()

◆ IsSubnetDirectedBroadcast()

bool ns3::Ipv4Address::IsSubnetDirectedBroadcast ( Ipv4Mask const &  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 255 of file ipv4-address.cc.

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

Referenced by ns3::Ipv4L3Protocol::IsUnicast(), 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 348 of file ipv4-address.cc.

◆ 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 333 of file ipv4-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::NscTcpL4Protocol::AddInterface(), ns3::NscTcpSocketImpl::Connect(), ns3::PbbAddressBlockIpv4::PrintAddress(), and ns3::PbbMessageIpv4::PrintOriginatorAddress().

+ Here is the caller graph for this function:

◆ Serialize()

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

◆ Set() [1/2]

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

◆ Set() [2/2]

void ns3::Ipv4Address::Set ( char const *  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 230 of file ipv4-address.cc.

References first::address, ns3::AsciiToIpv4Host(), m_address, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator!=

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

Not equal to operator.

Parameters
athe first operand.
bthe first operand.
Returns
true if the operands are not equal.
Parameters
athe first operand
bthe first operand
Returns
true if the operands are not equal

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

◆ operator<

bool operator< ( Ipv4Address const &  a,
Ipv4Address const &  b 
)
friend

Less than to operator.

Parameters
athe first operand.
bthe first operand.
Returns
true if the first operand is less than the second.
Parameters
athe first operand
bthe first operand
Returns
true if the operand a is less than operand b

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

◆ operator==

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

Equal to operator.

Parameters
athe first operand.
bthe first operand.
Returns
true if the operands are equal.
Parameters
athe first operand
bthe first operand
Returns
true if the operands are equal

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

Member Data Documentation

◆ m_address

uint32_t ns3::Ipv4Address::m_address
private

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