Describes an IPv6 prefix. More...

#include "ipv6-address.h"

Public Member Functions
	Ipv6Prefix ()
	Default constructor. More...

	Ipv6Prefix (uint8_t prefix[16])
	Constructs an Ipv6Prefix by using the input 16 bytes. More...

	Ipv6Prefix (char const *prefix)
	Constructs an Ipv6Prefix by using the input string. More...

	Ipv6Prefix (uint8_t prefix)
	Constructs an Ipv6Prefix by using the input number of bits. More...

	Ipv6Prefix (Ipv6Prefix const &prefix)
	Copy constructor. More...

	Ipv6Prefix (Ipv6Prefix const *prefix)
	Copy constructor. More...

	~Ipv6Prefix ()
	Destructor. More...

void	GetBytes (uint8_t buf[16]) const
	Get the bytes corresponding to the prefix. More...

uint8_t	GetPrefixLength () const
	Get prefix length. More...

bool	IsEqual (const Ipv6Prefix &other) const
	Comparison operation between two Ipv6Prefix. More...

bool	IsMatch (Ipv6Address a, Ipv6Address b) const
	If the Address match the type. More...

void	Print (std::ostream &os) const
	Print this address to the given output stream. More...

Static Public Member Functions
static Ipv6Prefix	GetLoopback ()
	Get the loopback prefix ( /128). More...

static Ipv6Prefix	GetOnes ()
	Get the "all-1" IPv6 mask (ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff). More...

static Ipv6Prefix	GetZero ()
	Get the zero prefix ( /0). More...

Private Attributes
uint8_t	m_prefix [16]
	The prefix representation. More...

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

bool	operator== (Ipv6Prefix const &a, Ipv6Prefix const &b)
	Equal to operator. More...

Detailed Description

Describes an IPv6 prefix.

It is just a bitmask like Ipv4Mask.

See also: Ipv6Address; Ipv6Prefix Attribute

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

Constructor & Destructor Documentation

ns3::Ipv6Prefix::Ipv6Prefix ( )

Default constructor.

Definition at line 842 of file ipv6-address.cc.

References m_prefix, and NS_LOG_FUNCTION.

ns3::Ipv6Prefix::Ipv6Prefix ( uint8_t prefix[16] )

Constructs an Ipv6Prefix by using the input 16 bytes.

Parameters

prefix the 128-bit prefix

Definition at line 854 of file ipv6-address.cc.

References m_prefix, and NS_LOG_FUNCTION.

ns3::Ipv6Prefix::Ipv6Prefix ( char const * prefix )

Constructs an Ipv6Prefix by using the input string.

Parameters

prefix the 128-bit prefix

Definition at line 848 of file ipv6-address.cc.

References ns3::AsciiToIpv6Host(), m_prefix, and NS_LOG_FUNCTION.

Here is the call graph for this function:

ns3::Ipv6Prefix::Ipv6Prefix ( uint8_t prefix )

Constructs an Ipv6Prefix by using the input number of bits.

Parameters

prefix number of bits of the prefix (0 - 128)

Note: A valid number of bits is between 0 and 128).

Definition at line 860 of file ipv6-address.cc.

References m_prefix, NS_ASSERT, and NS_LOG_FUNCTION.

ns3::Ipv6Prefix::Ipv6Prefix ( Ipv6Prefix const & prefix )

Copy constructor.

Parameters

prefix Ipv6Prefix object

Definition at line 895 of file ipv6-address.cc.

References m_prefix.

ns3::Ipv6Prefix::Ipv6Prefix ( Ipv6Prefix const * prefix )

Copy constructor.

Parameters

prefix Ipv6Prefix pointer

Definition at line 900 of file ipv6-address.cc.

References m_prefix.

ns3::Ipv6Prefix::~Ipv6Prefix ( )

Destructor.

Definition at line 905 of file ipv6-address.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::Ipv6Prefix::GetBytes ( uint8_t buf[16] ) const

Get the bytes corresponding to the prefix.

Parameters

buf	buffer to store the data

Definition at line 960 of file ipv6-address.cc.

References m_prefix, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6AddressGeneratorImpl::Init(), and ns3::Ipv6AddressGeneratorImpl::PrefixToIndex().

Here is the caller graph for this function:

Ipv6Prefix ns3::Ipv6Prefix::GetLoopback ( void )

static

Get the loopback prefix ( /128).

Returns: a Ipv6Prefix corresponding to loopback prefix

Definition at line 939 of file ipv6-address.cc.

References NS_LOG_FUNCTION_NOARGS.

Ipv6Prefix ns3::Ipv6Prefix::GetOnes ( void )

static

Get the "all-1" IPv6 mask (ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff).

Returns: /128 Ipv6Prefix representation

Definition at line 946 of file ipv6-address.cc.

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Ipv6StaticRouting::AddHostRouteTo(), ns3::Ipv6RoutingTableEntry::CreateHostRouteTo(), and ns3::Ipv6RoutingTableEntry::IsHost().

Here is the caller graph for this function:

uint8_t ns3::Ipv6Prefix::GetPrefixLength ( void ) const

Get prefix length.

Returns: prefix length

Definition at line 966 of file ipv6-address.cc.

References m_prefix, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6StaticRouting::GetDefaultRoute(), ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupStatic(), ns3::operator<<(), Print(), ns3::RipNg::PrintRoutingTable(), and ns3::Ipv6StaticRouting::PrintRoutingTable().

Here is the caller graph for this function:

Ipv6Prefix ns3::Ipv6Prefix::GetZero ( void )

static

Get the zero prefix ( /0).

Returns: an Ipv6Prefix

Definition at line 953 of file ipv6-address.cc.

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::RipNg::AddDefaultRouteTo(), ns3::RipNg::DoSendRouteUpdate(), ns3::RipNg::HandleRequests(), and ns3::Ipv6StaticRouting::SetDefaultRoute().

Here is the caller graph for this function:

bool ns3::Ipv6Prefix::IsEqual ( const Ipv6Prefix & other ) const

Comparison operation between two Ipv6Prefix.

Parameters

other the IPv6 prefix to which to compare this prefix

Returns: true if the prefixes are equal, false otherwise

Definition at line 986 of file ipv6-address.cc.

References m_prefix.

Referenced by ns3::Ipv6RoutingTableEntry::IsHost().

Here is the caller graph for this function:

bool ns3::Ipv6Prefix::IsMatch	(	Ipv6Address	a,
		Ipv6Address	b
	)		const

If the Address match the type.

Parameters

a	a first address
b	a second address

Returns: true if the type match, false otherwise

Definition at line 911 of file ipv6-address.cc.

References ns3::Ipv6Address::GetBytes(), m_prefix, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6Interface::GetAddressMatchingDestination(), ns3::Ipv6StaticRouting::HasNetworkDest(), ns3::RipNg::Lookup(), and ns3::Ipv6StaticRouting::LookupStatic().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Print this address to the given output stream.

The print format is in the typical "2001:660:4701::1".

Parameters

os	the output stream to which this Ipv6Address is printed

Definition at line 932 of file ipv6-address.cc.

References GetPrefixLength(), and NS_LOG_FUNCTION.

Referenced by ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

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

friend

Not equal to operator.

Parameters

a	the first operand
b	the first operand

Returns: true if the operands are not equal

Definition at line 575 of file ipv6-address.h.

bool operator==	(	Ipv6Prefix const &	a,
		Ipv6Prefix const &	b
	)

friend

Equal to operator.

Parameters

a	the first operand
b	the first operand

Returns: true if the operands are equal

Definition at line 570 of file ipv6-address.h.

Member Data Documentation

uint8_t ns3::Ipv6Prefix::m_prefix[16]

private

The prefix representation.

Definition at line 495 of file ipv6-address.h.

Referenced by GetBytes(), GetPrefixLength(), Ipv6Prefix(), IsEqual(), IsMatch(), ns3::operator!=(), and ns3::operator==().

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

src/network/utils/ipv6-address.h
src/network/utils/ipv6-address.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation