Describes an IPv6 address. More...

#include "ipv6-address.h"

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

	Ipv6Address (char const *address)
	Constructs an Ipv6Address by parsing the input C-string. More...

	Ipv6Address (uint8_t address[16])
	Constructs an Ipv6Address by using the input 16 bytes. More...

	Ipv6Address (Ipv6Address const &addr)
	Copy constructor. More...

	Ipv6Address (Ipv6Address const *addr)
	Copy constructor. More...

	~Ipv6Address ()
	Destructor. More...

Ipv6Address	CombinePrefix (Ipv6Prefix const &prefix) const
	Combine this address with a prefix. More...

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

Ipv4Address	GetIpv4MappedAddress () const
	Return the Ipv4 address. More...

bool	HasPrefix (Ipv6Prefix const &prefix) const
	Compares an address and a prefix. More...

bool	IsAllNodesMulticast () const
	If the IPv6 address is "all nodes multicast" (ff02::1/8). More...

bool	IsAllRoutersMulticast () const
	If the IPv6 address is "all routers multicast" (ff02::2/8). More...

bool	IsAny () const
	If the IPv6 address is the "Any" address. More...

bool	IsDocumentation () const
	If the IPv6 address is a documentation address (2001:DB8::/32). More...

NS_DEPRECATED_3_31 bool	IsEqual (const Ipv6Address &other) const
	Comparison operation between two Ipv6Addresses. More...

bool	IsInitialized (void) const

bool	IsIpv4MappedAddress () const
	If the address is an IPv4-mapped address. More...

bool	IsLinkLocal () const
	If the IPv6 address is a link-local address (fe80::/64). More...

bool	IsLinkLocalMulticast () const
	If the IPv6 address is link-local multicast (ff02::/16). More...

bool	IsLocalhost () const
	If the IPv6 address is localhost (::1). More...

bool	IsMulticast () const
	If the IPv6 address is multicast (ff00::/8). More...

bool	IsSolicitedMulticast () const
	If the IPv6 address is a Solicited multicast address. More...

	operator Address () const
	Convert to Address object. More...

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

void	Serialize (uint8_t buf[16]) const
	Serialize this address to a 16-byte buffer. More...

void	Set (char const *address)
	Sets an Ipv6Address by parsing the input C-string. More...

void	Set (uint8_t address[16])
	Set an Ipv6Address by using the input 16 bytes. More...

Static Public Member Functions
static Ipv6Address	ConvertFrom (const Address &address)
	Convert the Address object into an Ipv6Address ones. More...

static Ipv6Address	Deserialize (const uint8_t buf[16])
	Deserialize this address. More...

static Ipv6Address	GetAllHostsMulticast ()
	Get the "all hosts multicast" address. More...

static Ipv6Address	GetAllNodesMulticast ()
	Get the "all nodes multicast" address. More...

static Ipv6Address	GetAllRoutersMulticast ()
	Get the "all routers multicast" address. More...

static Ipv6Address	GetAny ()
	Get the "any" (::) Ipv6Address. More...

static Ipv6Address	GetLoopback ()
	Get the loopback address. More...

static Ipv6Address	GetOnes ()
	Get the "all-1" IPv6 address (ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff). More...

static Ipv6Address	GetZero ()
	Get the 0 (::) Ipv6Address. More...

static bool	IsMatchingType (const Address &address)
	If the Address matches the type. More...

static Ipv6Address	MakeAutoconfiguredAddress (Address addr, Ipv6Address prefix)
	Make the autoconfigured IPv6 address from a Mac address. More...

static Ipv6Address	MakeAutoconfiguredAddress (Address addr, Ipv6Prefix prefix)
	Make the autoconfigured IPv6 address from a Mac address. More...

static Ipv6Address	MakeAutoconfiguredAddress (Mac16Address addr, Ipv6Address prefix)
	Make the autoconfigured IPv6 address with Mac16Address. More...

static Ipv6Address	MakeAutoconfiguredAddress (Mac48Address addr, Ipv6Address prefix)
	Make the autoconfigured IPv6 address with Mac48Address. More...

static Ipv6Address	MakeAutoconfiguredAddress (Mac64Address addr, Ipv6Address prefix)
	Make the autoconfigured IPv6 address with Mac64Address. More...

static Ipv6Address	MakeAutoconfiguredAddress (Mac8Address addr, Ipv6Address prefix)
	Make the autoconfigured IPv6 address with Mac8Address. More...

static Ipv6Address	MakeAutoconfiguredLinkLocalAddress (Address mac)
	Make the autoconfigured link-local IPv6 address from a Mac address. More...

static Ipv6Address	MakeAutoconfiguredLinkLocalAddress (Mac16Address mac)
	Make the autoconfigured link-local IPv6 address with Mac16Address. More...

static Ipv6Address	MakeAutoconfiguredLinkLocalAddress (Mac48Address mac)
	Make the autoconfigured link-local IPv6 address with Mac48Address. More...

static Ipv6Address	MakeAutoconfiguredLinkLocalAddress (Mac64Address mac)
	Make the autoconfigured link-local IPv6 address with Mac64Address. More...

static Ipv6Address	MakeAutoconfiguredLinkLocalAddress (Mac8Address mac)
	Make the autoconfigured link-local IPv6 address with Mac8Address. More...

static Ipv6Address	MakeIpv4MappedAddress (Ipv4Address addr)
	Make the Ipv4-mapped IPv6 address. More...

static Ipv6Address	MakeSolicitedAddress (Ipv6Address addr)
	Make the solicited IPv6 address. More...

Private Member Functions
Address	ConvertTo (void) const
	convert the IPv6Address object to an Address object. More...

Static Private Member Functions
static uint8_t	GetType (void)
	Return the Type of address. More...

Private Attributes
uint8_t	m_address [16]
	The address representation on 128 bits (16 bytes). More...

bool	m_initialized
	IPv6 address has been explicitly initialized to a valid value. More...

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

bool	operator< (Ipv6Address const &a, Ipv6Address const &b)
	Less than to operator. More...

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

Detailed Description

Describes an IPv6 address.

See also: Ipv6Prefix; Ipv6Address Attribute

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

Constructor & Destructor Documentation

◆ Ipv6Address() [1/5]

ns3::Ipv6Address::Ipv6Address ( )

Default constructor.

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

References m_address, m_initialized, and NS_LOG_FUNCTION.

◆ Ipv6Address() [2/5]

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

Constructs an Ipv6Address by parsing the input C-string.

Parameters

address the C-string containing the IPv6 address (e.g. 2001:660:4701::1).

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

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

Here is the call graph for this function:

◆ Ipv6Address() [3/5]

ns3::Ipv6Address::Ipv6Address ( uint8_t address[16] )

Constructs an Ipv6Address by using the input 16 bytes.

Parameters

address the 128-bit address

Warning: the parameter must point on a 16 bytes integer array!

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

References first::address, m_address, m_initialized, and NS_LOG_FUNCTION.

◆ Ipv6Address() [4/5]

ns3::Ipv6Address::Ipv6Address ( Ipv6Address const & addr )

Copy constructor.

Parameters

addr	Ipv6Address object

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

References m_address, and m_initialized.

◆ Ipv6Address() [5/5]

ns3::Ipv6Address::Ipv6Address ( Ipv6Address const * addr )

Copy constructor.

Parameters

addr	Ipv6Address pointer

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

References m_address, and m_initialized.

◆ ~Ipv6Address()

ns3::Ipv6Address::~Ipv6Address ( )

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CombinePrefix()

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

Combine this address with a prefix.

Parameters

prefix a IPv6 prefix

Returns: an IPv6 address that is this address combined (bitwise AND) with a prefix, yielding an IPv6 network address.

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

References m_address, NS_LOG_FUNCTION, and Set().

Referenced by ns3::RipNg::HandleRequests(), ns3::RipNg::HandleResponses(), HasPrefix(), ns3::Ipv6AddressHelper::Ipv6AddressHelper(), IsDocumentation(), ns3::Ipv6InterfaceAddress::IsInSameSubnet(), IsLinkLocal(), ns3::Ipv6AddressGeneratorImpl::IsNetworkAllocated(), IsSolicitedMulticast(), MakeAutoconfiguredAddress(), ns3::Ipv6AddressHelper::NewAddress(), ns3::Ipv6StaticRouting::NotifyInterfaceUp(), and ns3::Ipv6AddressHelper::SetBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConvertFrom()

Ipv6Address ns3::Ipv6Address::ConvertFrom ( const Address & address )

static

Convert the Address object into an Ipv6Address ones.

Parameters

address address to convert

Returns: an Ipv6Address

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

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

Referenced by ns3::UdpSocketImpl::DoSend(), ns3::UdpSocketImpl::GetPeerName(), ns3::ThreeGppHttpClient::OpenConnection(), ns3::PbbAddressBlockIpv6::PrintAddress(), ns3::PbbMessageIpv6::PrintOriginatorAddress(), ns3::UdpClient::Send(), ns3::UdpEchoClient::Send(), ns3::UdpTraceClient::SendPacket(), ns3::TcpL4Protocol::SendPacket(), UanExperiment::SendSinglePacket(), ns3::PbbAddressBlockIpv6::SerializeAddress(), ns3::PbbMessageIpv6::SerializeOriginatorAddress(), 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:

◆ ConvertTo()

Address ns3::Ipv6Address::ConvertTo ( void ) const

private

convert the IPv6Address object to an Address object.

Returns: the Address object corresponding to this object.

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

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

Here is the call graph for this function:

◆ Deserialize()

Ipv6Address ns3::Ipv6Address::Deserialize ( const uint8_t buf[16] )

static

Deserialize this address.

Parameters

buf	buffer to read address from

Returns: an Ipv6Address

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

References m_initialized, and NS_LOG_FUNCTION.

Referenced by ns3::SixLowPanNetDevice::CleanPrefix(), ns3::Inet6SocketAddress::ConvertFrom(), ConvertFrom(), ns3::SixLowPanNetDevice::DecompressLowPanIphc(), ns3::Ipv6PacketInfoTag::Deserialize(), ns3::PbbAddressBlockIpv6::DeserializeAddress(), and ns3::PbbMessageIpv6::DeserializeOriginatorAddress().

Here is the caller graph for this function:

◆ GetAllHostsMulticast()

Ipv6Address ns3::Ipv6Address::GetAllHostsMulticast ( )

static

Get the "all hosts multicast" address.

Returns: the "ff02::3/8" Ipv6Address representation

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

References NS_LOG_FUNCTION_NOARGS.

◆ GetAllNodesMulticast()

Ipv6Address ns3::Ipv6Address::GetAllNodesMulticast ( )

static

Get the "all nodes multicast" address.

Returns: the "ff02::2/8" Ipv6Address representation

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Radvd::HandleRead(), ns3::Radvd::Send(), ns3::Icmpv6L4Protocol::SendNS(), and ns3::Radvd::StartApplication().

Here is the caller graph for this function:

◆ GetAllRoutersMulticast()

Ipv6Address ns3::Ipv6Address::GetAllRoutersMulticast ( )

static

Get the "all routers multicast" address.

Returns: the "ff02::2/8" Ipv6Address representation

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Icmpv6L4Protocol::FunctionDadTimeout(), ns3::Ipv6EndPointDemux::Lookup(), and ns3::Radvd::StartApplication().

Here is the caller graph for this function:

◆ GetAny()

Ipv6Address ns3::Ipv6Address::GetAny ( void )

static

Get the "any" (::) Ipv6Address.

Returns: the "any" (::) Ipv6Address

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Ipv6L3Protocol::AddAutoconfiguredAddress(), ns3::Ipv6EndPointDemux::Allocate(), ns3::Ipv6RawSocketImpl::Bind(), ns3::UdpSocketImpl::Bind(), ns3::TcpSocketBase::Bind(), ns3::SixLowPanNetDevice::CompressLowPanIphc(), ns3::SixLowPanNetDevice::DecompressLowPanIphc(), ns3::RipNg::DoSendRouteUpdate(), ns3::UdpSocketImpl::DoSendTo(), ns3::Icmpv6L4Protocol::ForgeNA(), ns3::Ipv6RawSocketImpl::ForwardUp(), ns3::Ipv6InterfaceContainer::GetLinkLocalAddress(), ns3::Icmpv6L4Protocol::HandleNS(), ns3::RipNg::HandleRequests(), ns3::RipNg::HandleResponses(), ns3::Icmpv6L4Protocol::HandleRS(), ns3::Ipv6L3Protocol::IpMulticastForward(), ns3::Socket::Ipv6LeaveGroup(), ns3::Ipv6RawSocketImpl::Ipv6RawSocketImpl(), ns3::Ipv6EndPointDemux::Lookup(), MakeAutoconfiguredAddress(), MakeAutoconfiguredLinkLocalAddress(), ns3::Ipv6L3Protocol::RemoveAutoconfiguredAddress(), ns3::Icmpv6L4Protocol::SendNA(), ns3::Icmpv6L4Protocol::SendNS(), ns3::Ipv6L3Protocol::SendRealOut(), ns3::RipNg::SendRouteRequest(), ns3::Ipv6InterfaceContainer::SetDefaultRoute(), ns3::Ipv6InterfaceContainer::SetDefaultRouteInAllNodes(), UanExperiment::SetupApplications(), ns3::Ipv6EndPointDemux::SimpleLookup(), ns3::UdpEchoServer::StartApplication(), and ns3::UdpServer::StartApplication().

Here is the caller graph for this function:

◆ GetBytes()

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

Get the bytes corresponding to the address.

Parameters

buf	buffer to store the data

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

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::SixLowPanNetDevice::CompressLowPanHc1(), ns3::SixLowPanNetDevice::CompressLowPanIphc(), ns3::SixLowPanNetDevice::DecompressLowPanIphc(), ns3::Ipv6AddressGeneratorImpl::Init(), ns3::Ipv6AddressGeneratorImpl::InitAddress(), ns3::Ipv6Prefix::IsMatch(), MakeAutoconfiguredAddress(), ns3::Ipv6AddressHelper::NewAddress(), ns3::Ipv6AddressHelper::NewNetwork(), ns3::Ipv6AddressGeneratorImpl::NextNetwork(), ns3::Icmpv6OptionPrefixInformation::Serialize(), and ns3::WriteTo().

Here is the caller graph for this function:

◆ GetIpv4MappedAddress()

Ipv4Address ns3::Ipv6Address::GetIpv4MappedAddress ( ) const

Return the Ipv4 address.

Returns: Ipv4 address

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

References ns3::Ipv4Address::Deserialize(), NS_LOG_FUNCTION, and Serialize().

Referenced by ns3::TcpSocketBase::Connect(), ns3::UdpSocketImpl::DoSendTo(), and ns3::TcpL4Protocol::SendPacketV6().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLoopback()

Ipv6Address ns3::Ipv6Address::GetLoopback ( void )

static

Get the loopback address.

Returns: the "::1/128" Ipv6Address representation.

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Ipv6L3Protocol::RemoveAddress(), and ns3::Ipv6L3Protocol::SetupLoopback().

Here is the caller graph for this function:

◆ GetOnes()

Ipv6Address ns3::Ipv6Address::GetOnes ( void )

static

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

Returns: all-1 Ipv6Address representation

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::SixLowPanNetDevice::AddContext(), ns3::SixLowPanNetDevice::FindMulticastCompressionContext(), ns3::SixLowPanNetDevice::FindUnicastCompressionContext(), HasPrefix(), and MakeAutoconfiguredAddress().

Here is the caller graph for this function:

◆ GetType()

uint8_t ns3::Ipv6Address::GetType ( void )

staticprivate

Return the Type of address.

Returns: type of address

Definition at line 855 of file ipv6-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()

Ipv6Address ns3::Ipv6Address::GetZero ( void )

static

Get the 0 (::) Ipv6Address.

Returns: the :: Ipv6Address representation

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

References NS_LOG_FUNCTION_NOARGS, and zero.

Referenced by ns3::Ipv6L3Protocol::AddAddress(), ns3::Ipv6RoutingTableEntry::CreateDefaultRoute(), ns3::TapFdNetDeviceHelper::CreateFileDescriptor(), ns3::Ipv6FlowClassifier::FindFlow(), ns3::Icmpv6L4Protocol::HandleRA(), ns3::Ipv6AddressHelper::Ipv6AddressHelper(), ns3::Ipv6RoutingTableEntry::IsDefault(), ns3::Ipv6RoutingTableEntry::IsGateway(), ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupStatic(), ns3::Ipv6AddressHelper::NewAddress(), ns3::Ipv6StaticRouting::NotifyAddRoute(), ns3::Ipv6StaticRouting::NotifyRemoveRoute(), ns3::Ipv6L3Protocol::Send(), ns3::Ipv6AddressHelper::SetBase(), and ns3::TapFdNetDeviceHelper::TapFdNetDeviceHelper().

Here is the caller graph for this function:

◆ HasPrefix()

bool ns3::Ipv6Address::HasPrefix ( Ipv6Prefix const & prefix ) const

Compares an address and a prefix.

Parameters

prefix the prefix to compare with

Returns: true if the address has the given prefix

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

References CombinePrefix(), GetOnes(), NS_LOG_FUNCTION, and anonymous_namespace{print-introspected-doxygen.cc}::reference.

Here is the call graph for this function:

◆ IsAllNodesMulticast()

bool ns3::Ipv6Address::IsAllNodesMulticast ( ) const

If the IPv6 address is "all nodes multicast" (ff02::1/8).

Returns: true if "all nodes multicast", false otherwise

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

References NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::Receive().

Here is the caller graph for this function:

◆ IsAllRoutersMulticast()

bool ns3::Ipv6Address::IsAllRoutersMulticast ( ) const

If the IPv6 address is "all routers multicast" (ff02::2/8).

Returns: true if "all routers multicast", false otherwise

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

References NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::Receive().

Here is the caller graph for this function:

◆ IsAny()

bool ns3::Ipv6Address::IsAny ( void ) const

If the IPv6 address is the "Any" address.

Returns: true if it is, false otherwise

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

References NS_LOG_FUNCTION.

Referenced by ns3::Ipv6Interface::AddAddress(), ns3::Ipv6L3Protocol::AddAutoconfiguredAddress(), ns3::Icmpv6L4Protocol::ForgeRS(), ns3::NdiscCache::Entry::FunctionDelayTimeout(), ns3::NdiscCache::Entry::FunctionProbeTimeout(), ns3::NdiscCache::Entry::FunctionRetransmitTimeout(), ns3::Ipv6RawSocketImpl::GetPeerName(), ns3::Icmpv6L4Protocol::HandleNS(), ns3::Ipv6L3Protocol::IpForward(), ns3::Ipv6RawSocketImpl::Ipv6JoinGroup(), ns3::UdpSocketImpl::Ipv6JoinGroup(), ns3::Socket::Ipv6LeaveGroup(), ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupStatic(), MakeAutoconfiguredAddress(), MakeAutoconfiguredLinkLocalAddress(), ns3::Icmpv6L4Protocol::SendRS(), ns3::Ipv6RawSocketImpl::SendTo(), and ns3::Ping6::StartApplication().

Here is the caller graph for this function:

◆ IsDocumentation()

bool ns3::Ipv6Address::IsDocumentation ( ) const

If the IPv6 address is a documentation address (2001:DB8::/32).

Returns: true if the address is documentation, false otherwise

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

References CombinePrefix(), and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::IpForward().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsEqual()

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

Comparison operation between two Ipv6Addresses.

Deprecated:: Use the == operator (same functionality)

Parameters

other the IPv6 address to which to compare this address

Returns: true if the addresses are equal, false otherwise

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

References m_address, and NS_LOG_FUNCTION.

◆ IsInitialized()

bool ns3::Ipv6Address::IsInitialized ( void ) const

Returns: true if address is initialized (i.e., set to something), false otherwise

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

References m_initialized, and NS_LOG_FUNCTION.

◆ IsIpv4MappedAddress()

bool ns3::Ipv6Address::IsIpv4MappedAddress ( ) const

If the address is an IPv4-mapped address.

Returns: true if address is an IPv4-mapped address, otherwise false.

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

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::TcpSocketBase::Connect(), ns3::UdpSocketImpl::DoSendTo(), Print(), ns3::UdpL4Protocol::Receive(), and ns3::TcpL4Protocol::SendPacketV6().

Here is the caller graph for this function:

◆ IsLinkLocal()

bool ns3::Ipv6Address::IsLinkLocal ( ) const

If the IPv6 address is a link-local address (fe80::/64).

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

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

References CombinePrefix(), and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6StaticRouting::AddHostRouteTo(), ns3::Ipv6StaticRouting::AddNetworkRouteTo(), ns3::RipNg::AddNetworkRouteTo(), ns3::SixLowPanNetDevice::CompressLowPanHc1(), ns3::SixLowPanNetDevice::CompressLowPanIphc(), Ipv6L3ProtocolTestCase::DoRun(), ns3::Icmpv6L4Protocol::FunctionDadTimeout(), ns3::AnimationInterface::GetIpv6Address(), ns3::Icmpv6L4Protocol::HandleNS(), ns3::RipNg::HandleRequests(), ns3::RipNg::HandleResponses(), ns3::Ipv6L3Protocol::IpForward(), ns3::Ipv6InterfaceAddress::IsInSameSubnet(), ns3::Icmpv6L4Protocol::Lookup(), ns3::RipNg::RouteInput(), ns3::Ipv6L3Protocol::Send(), and ns3::Ipv6L3Protocol::SourceAddressSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsLinkLocalMulticast()

bool ns3::Ipv6Address::IsLinkLocalMulticast ( ) const

If the IPv6 address is link-local multicast (ff02::/16).

Returns: true if link-local multicast, false otherwise

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

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6InterfaceAddress::IsInSameSubnet(), ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupStatic(), ns3::Ipv6L3Protocol::Send(), and ns3::Ipv6L3Protocol::SourceAddressSelection().

Here is the caller graph for this function:

◆ IsLocalhost()

bool ns3::Ipv6Address::IsLocalhost ( void ) const

If the IPv6 address is localhost (::1).

Returns: true if localhost, false otherwise

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

References NS_LOG_FUNCTION.

Referenced by ns3::Ipv6Interface::AddAddress().

Here is the caller graph for this function:

◆ IsMatchingType()

bool ns3::Ipv6Address::IsMatchingType ( const Address & address )

static

If the Address matches the type.

Parameters

address other address

Returns: true if the type matches, false otherwise

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

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

Referenced by ns3::UdpHeader::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()

bool ns3::Ipv6Address::IsMulticast ( void ) const

If the IPv6 address is multicast (ff00::/8).

Returns: true if multicast, false otherwise

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

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::Bind(), ns3::UdpSocketImpl::BindToNetDevice(), ns3::Ipv6FlowClassifier::Classify(), ns3::SixLowPanNetDevice::CompressLowPanIphc(), ns3::UdpSocketImpl::DoSendTo(), ns3::Icmpv6L4Protocol::HandleEchoRequest(), ns3::Ipv6L3Protocol::IpForward(), ns3::Ipv6L3Protocol::LocalDeliver(), ns3::Ipv6ExtensionLooseRouting::Process(), ns3::Ipv6Extension::ProcessOptions(), ns3::Ipv6L3Protocol::Receive(), ns3::RipNg::RouteInput(), ns3::Ipv6StaticRouting::RouteInput(), ns3::Ipv6L3Protocol::RouteInputError(), ns3::RipNg::RouteOutput(), ns3::Ipv6StaticRouting::RouteOutput(), ns3::Ipv6Interface::Send(), ns3::Icmpv6L4Protocol::SendNS(), and ns3::Icmpv6L4Protocol::SendRS().

Here is the caller graph for this function:

◆ IsSolicitedMulticast()

bool ns3::Ipv6Address::IsSolicitedMulticast ( ) const

If the IPv6 address is a Solicited multicast address.

Returns: true if it is, false otherwise

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

References CombinePrefix(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ MakeAutoconfiguredAddress() [1/6]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredAddress	(	Address	addr,
		Ipv6Address	prefix
	)

static

Make the autoconfigured IPv6 address from a Mac address.

Actually the MAC supported are: Mac8, Mac16, Mac48, and Mac64.

Parameters

addr	the MAC address.
prefix	the IPv6 prefix

Returns: autoconfigured IPv6 address

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

References ns3::Mac8Address::ConvertFrom(), ns3::Mac16Address::ConvertFrom(), ns3::Mac64Address::ConvertFrom(), ns3::Mac48Address::ConvertFrom(), GetAny(), IsAny(), ns3::Mac8Address::IsMatchingType(), ns3::Mac16Address::IsMatchingType(), ns3::Mac64Address::IsMatchingType(), ns3::Mac48Address::IsMatchingType(), and NS_ABORT_MSG.

Referenced by ns3::Ipv6L3Protocol::AddAutoconfiguredAddress(), ns3::SixLowPanNetDevice::CompressLowPanIphc(), ns3::SixLowPanNetDevice::DecompressLowPanHc1(), MakeAutoconfiguredAddress(), ns3::Ipv6AddressHelper::NewAddress(), and ns3::Ipv6L3Protocol::RemoveAutoconfiguredAddress().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeAutoconfiguredAddress() [2/6]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredAddress	(	Address	addr,
		Ipv6Prefix	prefix
	)

static

Make the autoconfigured IPv6 address from a Mac address.

Actually the MAC supported are: Mac8, Mac16, Mac48, and Mac64.

Parameters

addr	the MAC address.
prefix	the IPv6 prefix

Returns: autoconfigured IPv6 address

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

References CombinePrefix(), GetOnes(), and MakeAutoconfiguredAddress().

Here is the call graph for this function:

◆ MakeAutoconfiguredAddress() [3/6]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredAddress	(	Mac16Address	addr,
		Ipv6Address	prefix
	)

static

Make the autoconfigured IPv6 address with Mac16Address.

The EUI-64 scheme used is based on the RFC 4944.

Parameters

addr	the MAC address (16 bits).
prefix	the IPv6 prefix

Returns: autoconfigured IPv6 address

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

References ns3::Mac16Address::CopyTo(), GetBytes(), NS_LOG_FUNCTION, and Set().

Here is the call graph for this function:

◆ MakeAutoconfiguredAddress() [4/6]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredAddress	(	Mac48Address	addr,
		Ipv6Address	prefix
	)

static

Make the autoconfigured IPv6 address with Mac48Address.

The EUI-64 scheme used is based on RFC 2464.

Parameters

addr	the MAC address (48 bits).
prefix	the IPv6 prefix

Returns: autoconfigured IPv6 address

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

References ns3::Mac48Address::CopyTo(), GetBytes(), NS_LOG_FUNCTION, and Set().

Here is the call graph for this function:

◆ MakeAutoconfiguredAddress() [5/6]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredAddress	(	Mac64Address	addr,
		Ipv6Address	prefix
	)

static

Make the autoconfigured IPv6 address with Mac64Address.

Parameters

addr	the MAC address (64 bits).
prefix	the IPv6 prefix

Returns: autoconfigured IPv6 address

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

References ns3::Mac64Address::CopyTo(), GetBytes(), NS_LOG_FUNCTION, and Set().

Here is the call graph for this function:

◆ MakeAutoconfiguredAddress() [6/6]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredAddress	(	Mac8Address	addr,
		Ipv6Address	prefix
	)

static

Make the autoconfigured IPv6 address with Mac8Address.

The EUI-64 scheme used is loosely based on the RFC 2464.

Parameters

addr	the Mac8Address address (8 bits).
prefix	the IPv6 prefix

Returns: autoconfigured IPv6 address

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

References ns3::Mac8Address::CopyTo(), GetBytes(), NS_LOG_FUNCTION, and Set().

Here is the call graph for this function:

◆ MakeAutoconfiguredLinkLocalAddress() [1/5]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress ( Address mac )

static

Make the autoconfigured link-local IPv6 address from a Mac address.

Actually the MAC supported are: Mac8, Mac16, Mac48, and Mac64.

Parameters

mac	the MAC address.

Returns: autoconfigured link-local IPv6 address

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

References ns3::Mac8Address::ConvertFrom(), ns3::Mac16Address::ConvertFrom(), ns3::Mac64Address::ConvertFrom(), ns3::Mac48Address::ConvertFrom(), GetAny(), IsAny(), ns3::Mac8Address::IsMatchingType(), ns3::Mac16Address::IsMatchingType(), ns3::Mac64Address::IsMatchingType(), ns3::Mac48Address::IsMatchingType(), and NS_ABORT_MSG.

Referenced by ns3::SixLowPanNetDevice::CompressLowPanHc1(), ns3::SixLowPanNetDevice::CompressLowPanIphc(), ns3::SixLowPanNetDevice::DecompressLowPanHc1(), ns3::SixLowPanNetDevice::DecompressLowPanIphc(), and ns3::Ipv6Interface::DoSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeAutoconfiguredLinkLocalAddress() [2/5]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress ( Mac16Address mac )

static

Make the autoconfigured link-local IPv6 address with Mac16Address.

The EUI-64 scheme used is based on the RFC 4944.

Parameters

mac	the MAC address (16 bits).

Returns: autoconfigured link-local IPv6 address

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

References ns3::Mac16Address::CopyTo(), NS_LOG_FUNCTION, and Set().

Here is the call graph for this function:

◆ MakeAutoconfiguredLinkLocalAddress() [3/5]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress ( Mac48Address mac )

static

Make the autoconfigured link-local IPv6 address with Mac48Address.

The EUI-64 scheme used is based on RFC 2464.

Parameters

mac	the MAC address (48 bits).

Returns: autoconfigured link-local IPv6 address

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

References ns3::Mac48Address::CopyTo(), NS_LOG_FUNCTION, and Set().

Here is the call graph for this function:

◆ MakeAutoconfiguredLinkLocalAddress() [4/5]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress ( Mac64Address mac )

static

Make the autoconfigured link-local IPv6 address with Mac64Address.

Parameters

mac	the MAC address (64 bits).

Returns: autoconfigured link-local IPv6 address

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

References ns3::Mac64Address::CopyTo(), NS_LOG_FUNCTION, and Set().

Here is the call graph for this function:

◆ MakeAutoconfiguredLinkLocalAddress() [5/5]

Ipv6Address ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress ( Mac8Address mac )

static

Make the autoconfigured link-local IPv6 address with Mac8Address.

The EUI-64 scheme used is loosely based on the RFC 2464.

Parameters

mac	the MAC address (8 bits).

Returns: autoconfigured link-local IPv6 address

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

References ns3::Mac8Address::CopyTo(), NS_LOG_FUNCTION, and Set().

Here is the call graph for this function:

◆ MakeIpv4MappedAddress()

Ipv6Address ns3::Ipv6Address::MakeIpv4MappedAddress ( Ipv4Address addr )

static

Make the Ipv4-mapped IPv6 address.

Parameters

addr	the IPv4 address

Returns: Ipv4-mapped IPv6 address

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

References NS_LOG_FUNCTION, and ns3::Ipv4Address::Serialize().

Referenced by ns3::MockNetDevice::GetMulticast(), ns3::UdpL4Protocol::Receive(), and ns3::TcpL4Protocol::Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeSolicitedAddress()

Ipv6Address ns3::Ipv6Address::MakeSolicitedAddress ( Ipv6Address addr )

static

Make the solicited IPv6 address.

Parameters

addr	the IPv6 address

Returns: Solicited IPv6 address

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

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

Referenced by ns3::Ipv6Interface::AddAddress(), ns3::Icmpv6L4Protocol::DoDAD(), ns3::NdiscCache::Entry::FunctionRetransmitTimeout(), and ns3::Icmpv6L4Protocol::Lookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator Address()

ns3::Ipv6Address::operator Address ( ) const

Convert to Address object.

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

◆ Print()

void ns3::Ipv6Address::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 612 of file ipv6-address.cc.

References first::address, IsIpv4MappedAddress(), m_address, and NS_LOG_FUNCTION.

Referenced by ns3::PbbAddressBlockIpv6::PrintAddress(), and ns3::PbbMessageIpv6::PrintOriginatorAddress().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Serialize()

void ns3::Ipv6Address::Serialize ( uint8_t buf[16] ) const

Serialize this address to a 16-byte buffer.

Parameters

buf	the output buffer to which this address gets overwritten with this Ipv6Address

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

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6Header::CalculatePseudoHeaderChecksum(), ns3::SixLowPanNetDevice::CompressLowPanIphc(), ns3::Inet6SocketAddress::ConvertTo(), ConvertTo(), Ipv6AddressTestCase::DoRun(), GetIpv4MappedAddress(), ns3::Mac48Address::GetMulticast(), ns3::Ipv6QueueDiscItem::Hash(), MakeSolicitedAddress(), ns3::RipNgRte::Serialize(), ns3::Ipv6PacketInfoTag::Serialize(), ns3::Icmpv6NS::Serialize(), ns3::Icmpv6NA::Serialize(), ns3::Icmpv6Redirection::Serialize(), ns3::PbbAddressBlockIpv6::SerializeAddress(), and ns3::PbbMessageIpv6::SerializeOriginatorAddress().

Here is the caller graph for this function:

◆ Set() [1/2]

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

Sets an Ipv6Address by parsing the input C-string.

Parameters

address the C-string containing the IPv6 address (e.g. 2001:660:4701::1).

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

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

Referenced by CombinePrefix(), ns3::RipNgRte::Deserialize(), ns3::Icmpv6NS::Deserialize(), ns3::Icmpv6NA::Deserialize(), ns3::Icmpv6Redirection::Deserialize(), EpcTftClassifierTestSuite::EpcTftClassifierTestSuite(), MakeAutoconfiguredAddress(), MakeAutoconfiguredLinkLocalAddress(), MakeSolicitedAddress(), and ns3::ReadFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Set() [2/2]

void ns3::Ipv6Address::Set ( uint8_t address[16] )

Set an Ipv6Address by using the input 16 bytes.

Parameters

address the 128-bit address

Warning: the parameter must point on a 16 bytes integer array!

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

References first::address, m_address, m_initialized, and NS_LOG_FUNCTION.

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	Ipv6Address const &	a,
		Ipv6Address 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 681 of file ipv6-address.h.

◆ operator<

bool operator<	(	Ipv6Address const &	a,
		Ipv6Address const &	b
	)

friend

Less than to operator.

Parameters

a	the first operand.
b	the first operand.

Returns: true if the first operand is less than the second.

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

◆ operator==

bool operator==	(	Ipv6Address const &	a,
		Ipv6Address 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 676 of file ipv6-address.h.

Member Data Documentation

◆ m_address

uint8_t ns3::Ipv6Address::m_address[16]

private

The address representation on 128 bits (16 bytes).

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

Referenced by CombinePrefix(), GetBytes(), Ipv6Address(), IsEqual(), IsIpv4MappedAddress(), IsLinkLocalMulticast(), IsMulticast(), ns3::operator!=(), ns3::operator<(), ns3::operator==(), Print(), Serialize(), and Set().

◆ m_initialized

bool ns3::Ipv6Address::m_initialized

private

IPv6 address has been explicitly initialized to a valid value.

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

Referenced by Deserialize(), Ipv6Address(), IsInitialized(), and Set().

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 Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Ipv6Address() [1/5]

◆ Ipv6Address() [2/5]

◆ Ipv6Address() [3/5]

◆ Ipv6Address() [4/5]

◆ Ipv6Address() [5/5]

◆ ~Ipv6Address()

Member Function Documentation

◆ CombinePrefix()

◆ ConvertFrom()

◆ ConvertTo()

◆ Deserialize()

◆ GetAllHostsMulticast()

◆ GetAllNodesMulticast()

◆ GetAllRoutersMulticast()

◆ GetAny()

◆ GetBytes()

◆ GetIpv4MappedAddress()

◆ GetLoopback()

◆ GetOnes()

◆ GetType()

◆ GetZero()

◆ HasPrefix()

◆ IsAllNodesMulticast()

◆ IsAllRoutersMulticast()

◆ IsAny()

◆ IsDocumentation()

◆ IsEqual()

◆ IsInitialized()

◆ IsIpv4MappedAddress()

◆ IsLinkLocal()

◆ IsLinkLocalMulticast()

◆ IsLocalhost()

◆ IsMatchingType()

◆ IsMulticast()

◆ IsSolicitedMulticast()

◆ MakeAutoconfiguredAddress() [1/6]

◆ MakeAutoconfiguredAddress() [2/6]

◆ MakeAutoconfiguredAddress() [3/6]

◆ MakeAutoconfiguredAddress() [4/6]

◆ MakeAutoconfiguredAddress() [5/6]

◆ MakeAutoconfiguredAddress() [6/6]

◆ MakeAutoconfiguredLinkLocalAddress() [1/5]

◆ MakeAutoconfiguredLinkLocalAddress() [2/5]

◆ MakeAutoconfiguredLinkLocalAddress() [3/5]

◆ MakeAutoconfiguredLinkLocalAddress() [4/5]

◆ MakeAutoconfiguredLinkLocalAddress() [5/5]

◆ MakeIpv4MappedAddress()

◆ MakeSolicitedAddress()

◆ operator Address()

◆ Print()

◆ Serialize()

◆ Set() [1/2]

◆ Set() [2/2]

Friends And Related Function Documentation

◆ operator!=

◆ operator<

◆ operator==

Member Data Documentation

◆ m_address

◆ m_initialized