A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
ns3::Ipv4Mask Class Reference
Network » Address

a class to represent an Ipv4 address mask More...

#include "ipv4-address.h"

+ Collaboration diagram for ns3::Ipv4Mask:

Public Member Functions

 Ipv4Mask ()
 Will initialize to a garbage value (0x66666666) More...
 
 Ipv4Mask (const char *mask)
 
 Ipv4Mask (uint32_t mask)
 
uint32_t Get () const
 Get the host-order 32-bit IP mask. More...
 
uint32_t GetInverse () const
 Return the inverse mask in host order. More...
 
uint16_t GetPrefixLength () const
 
bool IsMatch (Ipv4Address a, Ipv4Address b) const
 
void Print (std::ostream &os) const
 Print this mask to the given output stream. More...
 
void Set (uint32_t mask)
 input mask is in host order. More...
 

Static Public Member Functions

static Ipv4Mask GetLoopback ()
 
static Ipv4Mask GetOnes ()
 
static Ipv4Mask GetZero ()
 

Private Attributes

uint32_t m_mask
 IP mask. More...
 

Friends

bool operator!= (const Ipv4Mask &a, const Ipv4Mask &b)
 Not equal to operator. More...
 
bool operator== (const Ipv4Mask &a, const Ipv4Mask &b)
 Equal to operator. More...
 

Detailed Description

a class to represent an Ipv4 address mask

The constructor takes arguments according to a few formats. Ipv4Mask ("255.255.255.255"), Ipv4Mask ("/32"), and Ipv4Mask (0xffffffff) are all equivalent.

See also
attribute_Ipv4Mask

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

Constructor & Destructor Documentation

◆ Ipv4Mask() [1/3]

ns3::Ipv4Mask::Ipv4Mask ( )

Will initialize to a garbage value (0x66666666)

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

References NS_LOG_FUNCTION.

◆ Ipv4Mask() [2/3]

ns3::Ipv4Mask::Ipv4Mask ( uint32_t  mask)
Parameters
maskbitwise integer representation of the mask

For example, the integer input 0xffffff00 yields a 24-bit mask

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

References NS_LOG_FUNCTION.

◆ Ipv4Mask() [3/3]

ns3::Ipv4Mask::Ipv4Mask ( const char *  mask)
Parameters
maskString constant either in "255.255.255.0" or "/24" format

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

References m_mask, NS_ABORT_MSG, NS_ASSERT, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Get()

uint32_t ns3::Ipv4Mask::Get ( ) const

Get the host-order 32-bit IP mask.

Returns
the host-order 32-bit IP mask

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

References m_mask, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4InterfaceAddress::Ipv4InterfaceAddress(), ns3::Ipv4Address::CombineMask(), ns3::Ipv4AddressGeneratorImpl::Init(), ns3::Ipv4Address::IsSubnetDirectedBroadcast(), ns3::Ipv4AddressGeneratorImpl::MaskToIndex(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessPointToPointLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), ns3::DhcpServer::SendOffer(), ns3::RipRte::Serialize(), and ns3::Ipv4AddressHelper::SetBase().

+ Here is the caller graph for this function:

◆ GetInverse()

uint32_t ns3::Ipv4Mask::GetInverse ( ) const

Return the inverse mask in host order.

Returns
The inverse mask

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

References m_mask, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4Address::GetSubnetDirectedBroadcast().

+ Here is the caller graph for this function:

◆ GetLoopback()

Ipv4Mask ns3::Ipv4Mask::GetLoopback ( )
static
Returns
the 255.0.0.0 mask corresponding to a typical loopback address

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Ipv4L3ClickProtocol::SetupLoopback(), and ns3::Ipv4L3Protocol::SetupLoopback().

+ Here is the caller graph for this function:

◆ GetOnes()

Ipv4Mask ns3::Ipv4Mask::GetOnes ( )
static
Returns
the 255.255.255.255 mask

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Ipv4StaticRouting::AddHostRouteTo(), ns3::TapBridge::CreateTap(), ns3::Ipv4Address::GetSubnetDirectedBroadcast(), ns3::Ipv4RoutingTableEntry::IsHost(), ns3::Ipv4Address::IsSubnetDirectedBroadcast(), ns3::Ipv4StaticRouting::NotifyInterfaceUp(), ns3::aodv::RoutingProtocol::RecvRequest(), ns3::aodv::RoutingProtocol::SendHello(), ns3::dsdv::RoutingProtocol::SendPeriodicUpdate(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::aodv::RoutingProtocol::SendRerrMessage(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), and ns3::dsdv::RoutingProtocol::SendTriggeredUpdate().

+ Here is the caller graph for this function:

◆ GetPrefixLength()

uint16_t ns3::Ipv4Mask::GetPrefixLength ( ) const
Returns
the prefix length of mask (the yy in x.x.x.x/yy notation)

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

References m_mask, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4StaticRouting::GetDefaultRoute(), ns3::Ipv4EndPointDemux::Lookup(), ns3::Rip::Lookup(), ns3::Ipv4StaticRouting::LookupStatic(), ns3::RipRte::Print(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), and ns3::GlobalRouter::ProcessSingleBroadcastLink().

+ Here is the caller graph for this function:

◆ GetZero()

Ipv4Mask ns3::Ipv4Mask::GetZero ( )
static
Returns
the 0.0.0.0 mask

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

References NS_LOG_FUNCTION_NOARGS, and zero.

Referenced by ns3::TapFdNetDeviceHelper::TapFdNetDeviceHelper(), ns3::Rip::AddDefaultRouteTo(), ns3::Ipv4RoutingTableEntry::CreateDefaultRoute(), ns3::TapFdNetDeviceHelper::CreateFileDescriptor(), ns3::Rip::DoSendRouteUpdate(), ns3::Rip::HandleRequests(), ns3::Rip::SendRouteRequest(), and ns3::Ipv4StaticRouting::SetDefaultRoute().

+ Here is the caller graph for this function:

◆ IsMatch()

bool ns3::Ipv4Mask::IsMatch ( Ipv4Address  a,
Ipv4Address  b 
) const
Parameters
afirst address to compare
bsecond address to compare
Returns
true if both addresses are equal in their masked bits, corresponding to this mask

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

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

Referenced by ns3::Rip::Lookup(), ns3::Ipv4GlobalRouting::LookupGlobal(), and ns3::Ipv4StaticRouting::LookupStatic().

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

◆ Print()

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

Print this mask to the given output stream.

The print format is in the typical "255.255.255.0"

Parameters
osThe output stream to which this Ipv4Address is printed

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

References m_mask, and NS_LOG_FUNCTION.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

◆ Set()

void ns3::Ipv4Mask::Set ( uint32_t  mask)

input mask is in host order.

Parameters
maskThe host order 32-bit mask

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

References m_mask, and NS_LOG_FUNCTION.

Referenced by EpcTftClassifierTestSuite::EpcTftClassifierTestSuite(), and ns3::RipRte::Deserialize().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator!=

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

Not equal to operator.

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

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

◆ operator==

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

Equal to operator.

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

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

Member Data Documentation

◆ m_mask

uint32_t ns3::Ipv4Mask::m_mask
private

IP mask.

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

Referenced by Ipv4Mask(), Get(), GetInverse(), GetPrefixLength(), IsMatch(), Print(), and Set().

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