IP v6 socket address class (IP v6 address & port). More...

#include <tsIPv6SocketAddress.h>

Inheritance diagram for ts::IPv6SocketAddress:

[legend]

Collaboration diagram for ts::IPv6SocketAddress:

[legend]

Public Types
using	Port = uint16_t
	The concept of port is used by TCP and UDP over IP networks.

Public Member Functions
	IPv6SocketAddress ()=default
	Default constructor.

	IPv6SocketAddress (const ByteBlock &bb, uint16_t port=AnyPort)
	Constructor from 16 bytes address and optional port.

	IPv6SocketAddress (const IPv6Address &addr, uint16_t port=AnyPort)
	Constructor from an IPv6 address and optional port.

	IPv6SocketAddress (const uint8_t *addr, size_t size, uint16_t port=AnyPort)
	Constructor from 16 bytes address and optional port.

	IPv6SocketAddress (const UString &name, Report &report)
	Constructor from a string "[addr]:port".

	IPv6SocketAddress (uint16_t h1, uint16_t h2, uint16_t h3, uint16_t h4, uint16_t h5, uint16_t h6, uint16_t h7, uint16_t h8, uint16_t port=AnyPort)
	Constructor from 8 hexlets and optional port.

	IPv6SocketAddress (uint64_t net, uint64_t ifid, uint16_t port=AnyPort)
	Constructor from network prefix and interface identifier.

virtual size_t	binarySize () const override
	Get the maximum binary size for an address of that class.

virtual void	clear ()
	Clear the object, address and port if there is any.

virtual void	clearAddress () override
	Clear the address field.

virtual void	clearPort ()
	Clear the port.

virtual const UChar *	familyName () const override
	Get a human-readable family name for an address of that class.

void	getAddress (ByteBlock &bb) const
	Get the IP address as a byte block.

virtual size_t	getAddress (void *addr, size_t size) const override
	Get the network address as binary data.

virtual bool	hasAddress () const override
	Check if this object is set to a valid address.

virtual bool	hasPort () const
	Check if a port is set.

uint16_t	hexlet (size_t i) const
	Get one of the 16-bit hexlets in the address.

uint64_t	interfaceIdentifier () const
	Get the interface identifier (64 least significant bits) of the IPv6 address.

virtual bool	isMulticast () const override
	Check if the address is a multicast address.

bool	match (const IPv6Address &other) const
	Check if this address "matches" another one.

bool	match (const IPv6SocketAddress &other) const
	Check if this socket address "matches" another one.

uint64_t	networkPrefix () const
	Get the network prefix (64 most significant bits) of the IPv6 address.

bool	operator< (const IPv6Address &other) const
	Comparison "less than" operator.

bool	operator< (const IPv6SocketAddress &other) const
	Comparison "less than" operator.

bool	operator== (const IPv6Address &other) const
	Equality operator.

bool	operator== (const IPv6SocketAddress &other) const
	Equality operator.

virtual Port	port () const override
	Get the port if there is one.

virtual bool	resolve (const UString &name, Report &report) override
	Decode a string containing a network address in family-specific format.

void	set (const ByteBlock &bb, uint16_t port)
	Set the socket address from 16 bytes and port.

void	set (const uint8_t *addr, size_t size, uint16_t port)
	Set the socket address from 16 bytes andport.

void	set (uint16_t h1, uint16_t h2, uint16_t h3, uint16_t h4, uint16_t h5, uint16_t h6, uint16_t h7, uint16_t h8, uint16_t port)
	Set the socket address from 8 hexlets and port.

void	set (uint64_t net, uint64_t ifid, uint16_t port)
	Set the socket address from network prefix and interface identifier and port.

void	setAddress (const ByteBlock &bb)
	Set the IP address from 16 bytes.

virtual bool	setAddress (const void *addr, size_t size) override
	Set the network address from binary data.

void	setAddress (uint16_t h1, uint16_t h2, uint16_t h3, uint16_t h4, uint16_t h5, uint16_t h6, uint16_t h7, uint16_t h8)
	Set the IP address from 8 hexlets.

void	setAddress (uint64_t net, uint64_t ifid)
	Set the IP address from network prefix and interface identifier.

virtual void	setPort (Port port) override
	Set the port.

ByteBlock	toBytes () const
	Get the IP address as a byte block.

virtual UString	toFullString () const override
	Convert to a string object in numeric format without the default compaction.

virtual UString	toString () const override
	Convert to a string object.

Static Public Attributes
static const IPv6Address	AnyAddress
	Wildcard integer value for "any IP address".

static constexpr Port	AnyPort = 0
	Wildcard integer value for "any port" or "no port".

static const IPv6SocketAddress	AnySocketAddress
	Wildcard socket address, unspecified address and port.

static constexpr size_t	BITS = 128
	Size in bits of an IPv6 address.

static constexpr size_t	BYTES = 16
	Size in bytes of an IPv6 address.

static const IPv6Address	LocalHost
	Local host address (::1).

Detailed Description

IP v6 socket address class (IP v6 address & port).

The string representation is "[addr]:port". In the template string "[addr]:port", the square brackets do not mean that "addr" is optional. According to IPv6 URL representation, the square brackets are actual characters in the string. The address and port fields are optional. If the address is specified alone, without port, the square brackets may be omitted.

Constructor & Destructor Documentation

◆ IPv6SocketAddress() [1/6]

ts::IPv6SocketAddress::IPv6SocketAddress	(	const IPv6Address &	addr,
		uint16_t	port = `AnyPort`
	)

inline

Constructor from an IPv6 address and optional port.

Parameters

[in]	addr	The IPv6 address.
[in]	port	The port number as an integer in host byte order.

◆ IPv6SocketAddress() [2/6]

ts::IPv6SocketAddress::IPv6SocketAddress	(	const uint8_t *	addr,
		size_t	size,
		uint16_t	port = `AnyPort`
	)

inline

Constructor from 16 bytes address and optional port.

Parameters

[in]	addr	Address of the memory area containing the IPv6 bytes.
[in]	size	Size of the memory area. If the size is shorter than 16, the IPv6 is padded on the left (most significant bytes) with zeroes. If the size is larger than 16, extra bytes are ignored.
[in]	port	The port number as an integer in host byte order.

◆ IPv6SocketAddress() [3/6]

ts::IPv6SocketAddress::IPv6SocketAddress	(	const ByteBlock &	bb,
		uint16_t	port = `AnyPort`
	)

inline

Constructor from 16 bytes address and optional port.

Parameters

[in]	bb	Byte block containing the IPv6 bytes. If the size is shorter than 16, the IPv6 is padded on the left (most significant bytes) with zeroes. If the size is larger than 16, extra bytes are ignored.
[in]	port	The port number as an integer in host byte order.

◆ IPv6SocketAddress() [4/6]

ts::IPv6SocketAddress::IPv6SocketAddress	(	uint16_t	h1,
		uint16_t	h2,
		uint16_t	h3,
		uint16_t	h4,
		uint16_t	h5,
		uint16_t	h6,
		uint16_t	h7,
		uint16_t	h8,
		uint16_t	port = `AnyPort`
	)

inline

Constructor from 8 hexlets and optional port.

Parameters

[in]	h1	First address hexlet.
[in]	h2	2nd address hexlet.
[in]	h3	3rd address hexlet.
[in]	h4	4th address hexlet.
[in]	h5	5th address hexlet.
[in]	h6	6th address hexlet.
[in]	h7	7th address hexlet.
[in]	h8	8th address hexlet.
[in]	port	The port number as an integer in host byte order.

◆ IPv6SocketAddress() [5/6]

ts::IPv6SocketAddress::IPv6SocketAddress	(	uint64_t	net,
		uint64_t	ifid,
		uint16_t	port = `AnyPort`
	)

inline

Constructor from network prefix and interface identifier.

Parameters

[in]	net	Network prefix.
[in]	ifid	Interface identifier.
[in]	port	The port number as an integer in host byte order.

◆ IPv6SocketAddress() [6/6]

ts::IPv6SocketAddress::IPv6SocketAddress	(	const UString &	name,
		Report &	report
	)

inline

Constructor from a string "[addr]:port".

Parameters

[in]	name	A string containing either a host name or a numerical representation of the address and optional port. In case of error, the integer value of the address is set to AnyAddress and port to AnyPort.
[in]	report	Where to report errors.

Member Function Documentation

◆ port()

virtual Port ts::IPv6SocketAddress::port ( ) const

overridevirtual

Get the port if there is one.

The default implementation returns AnyPort.

Returns: The port number or AnyPort if there is none.

Reimplemented from ts::AbstractNetworkAddress.

◆ setPort()

virtual void ts::IPv6SocketAddress::setPort ( Port port )

overridevirtual

Set the port.

The default implementation does nothing.

Parameters

[in] port The port number as an integer in host byte order.

Reimplemented from ts::AbstractNetworkAddress.

◆ resolve()

virtual bool ts::IPv6SocketAddress::resolve	(	const UString &	name,
		Report &	report
	)

overridevirtual

Decode a string containing a network address in family-specific format.

Parameters

[in]	name	A string containing either a host name or a numerical representation of the address.
[in]	report	Where to report errors.

Returns: True if name was successfully resolved, false otherwise. In the later case, the address is invalidated.

Reimplemented from ts::IPv6Address.

◆ toString()

virtual UString ts::IPv6SocketAddress::toString ( ) const

overridevirtual

Convert to a string object.

Returns: This object, converted as a string.

Reimplemented from ts::IPv6Address.

◆ toFullString()

virtual UString ts::IPv6SocketAddress::toFullString ( ) const

overridevirtual

Convert to a string object in numeric format without the default compaction.

The method toString() (inherited from StringifyInterface) returns a default representation of the string, with possible compaction of omitted defaults. This method returns a complete version of the address representation. The default implementation returns the same value as toString().

Returns: This object, converted as a string.

Reimplemented from ts::IPv6Address.

◆ set() [1/4]

void ts::IPv6SocketAddress::set	(	const uint8_t *	addr,
		size_t	size,
		uint16_t	port
	)

inline

Set the socket address from 16 bytes andport.

Parameters

[in]	addr	Address of the memory area containing the IPv6 bytes.
[in]	size	Size of the memory area. If the size is shorter than 16, the IPv6 is padded on the left (most significant bytes) with zeroes. If the size is larger than 16, extra bytes are ignored.
[in]	port	The port number as an integer in host byte order.

◆ set() [2/4]

void ts::IPv6SocketAddress::set	(	const ByteBlock &	bb,
		uint16_t	port
	)

inline

Set the socket address from 16 bytes and port.

Parameters

[in]	bb	Byte block containing the IPv6 bytes. If the size is shorter than 16, the IPv6 is padded on the left (most significant bytes) with zeroes. If the size is larger than 16, extra bytes are ignored.
[in]	port	The port number as an integer in host byte order.

◆ set() [3/4]

void ts::IPv6SocketAddress::set	(	uint16_t	h1,
		uint16_t	h2,
		uint16_t	h3,
		uint16_t	h4,
		uint16_t	h5,
		uint16_t	h6,
		uint16_t	h7,
		uint16_t	h8,
		uint16_t	port
	)

inline

Set the socket address from 8 hexlets and port.

Parameters

[in]	h1	First address hexlet.
[in]	h2	2nd address hexlet.
[in]	h3	3rd address hexlet.
[in]	h4	4th address hexlet.
[in]	h5	5th address hexlet.
[in]	h6	6th address hexlet.
[in]	h7	7th address hexlet.
[in]	h8	8th address hexlet.
[in]	port	The port number as an integer in host byte order.

◆ set() [4/4]

void ts::IPv6SocketAddress::set	(	uint64_t	net,
		uint64_t	ifid,
		uint16_t	port
	)

inline

Set the socket address from network prefix and interface identifier and port.

Parameters

[in]	net	Network prefix.
[in]	ifid	Interface identifier.
[in]	port	The port number as an integer in host byte order.

◆ match() [1/2]

bool ts::IPv6SocketAddress::match ( const IPv6SocketAddress & other ) const

Check if this socket address "matches" another one.

Parameters

[in] other Another instance to compare.

Returns: False if this and other addresses are both specified and are different or if the two ports are specified and different. True otherwise.

◆ operator==() [1/2]

bool ts::IPv6SocketAddress::operator== ( const IPv6SocketAddress & other ) const

inline

Equality operator.

Parameters

[in] other Another instance to compare with.

Returns: True if both object contains the same address, false otherwise.

◆ operator<() [1/2]

bool ts::IPv6SocketAddress::operator< ( const IPv6SocketAddress & other ) const

Comparison "less than" operator.

It does not really makes sense. Only defined to allow usage in containers.

Parameters

[in] other Other instance to compare.

Returns: True if this instance is less than to other.

◆ binarySize()

virtual size_t ts::IPv6Address::binarySize ( ) const

overridevirtualinherited

Get the maximum binary size for an address of that class.

Returns: The maximum binary size for an address of that class.

Implements ts::AbstractNetworkAddress.

◆ familyName()

virtual const UChar * ts::IPv6Address::familyName ( ) const

overridevirtualinherited

Get a human-readable family name for an address of that class.

This is typically something like "IPv4" or "IPv6".

Returns: A human-readable family name for an address of that class.

Implements ts::AbstractNetworkAddress.

◆ hasAddress()

virtual bool ts::IPv6Address::hasAddress ( ) const

overridevirtualinherited

Check if this object is set to a valid address.

Returns: True if this object is set to a valid address, false otherwise.

Implements ts::AbstractNetworkAddress.

◆ getAddress() [1/2]

virtual size_t ts::IPv6Address::getAddress	(	void *	addr,
		size_t	size
	)		const

overridevirtualinherited

Get the network address as binary data.

Parameters

[out]	addr	Address of binary buffer to receive binary data.
[in]	size	Size in bytes of buffer.

Returns: Number of copied bytes on success, zero on error (data too short).

Implements ts::AbstractNetworkAddress.

◆ getAddress() [2/2]

void ts::IPv6Address::getAddress ( ByteBlock & bb ) const

inlineinherited

Get the IP address as a byte block.

Parameters

[out] bb Byte block containing the IPv6 bytes.

◆ setAddress() [1/4]

virtual bool ts::IPv6Address::setAddress	(	const void *	addr,
		size_t	size
	)

overridevirtualinherited

Set the network address from binary data.

Parameters

[in]	addr	Address of binary data.
[in]	size	Size in bytes of binary data.

Returns: True on success, false on error (data too short).

Implements ts::AbstractNetworkAddress.

◆ setAddress() [2/4]

void ts::IPv6Address::setAddress ( const ByteBlock & bb )

inlineinherited

Set the IP address from 16 bytes.

Parameters

[in] bb Byte block containing the IPv6 bytes. If the size is shorter than 16, the IPv6 is padded on the left (most significant bytes) with zeroes. If the size is larger than 16, extra bytes are ignored.

◆ setAddress() [3/4]

void ts::IPv6Address::setAddress	(	uint16_t	h1,
		uint16_t	h2,
		uint16_t	h3,
		uint16_t	h4,
		uint16_t	h5,
		uint16_t	h6,
		uint16_t	h7,
		uint16_t	h8
	)

inherited

Set the IP address from 8 hexlets.

Parameters

[in]	h1	First address hexlet.
[in]	h2	2nd address hexlet.
[in]	h3	3rd address hexlet.
[in]	h4	4th address hexlet.
[in]	h5	5th address hexlet.
[in]	h6	6th address hexlet.
[in]	h7	7th address hexlet.
[in]	h8	8th address hexlet.

◆ setAddress() [4/4]

void ts::IPv6Address::setAddress	(	uint64_t	net,
		uint64_t	ifid
	)

inherited

Set the IP address from network prefix and interface identifier.

Parameters

[in]	net	Network prefix.
[in]	ifid	Interface identifier.

◆ clearAddress()

virtual void ts::IPv6Address::clearAddress ( )

overridevirtualinherited

Clear the address field.

Implements ts::AbstractNetworkAddress.

◆ isMulticast()

virtual bool ts::IPv6Address::isMulticast ( ) const

overridevirtualinherited

Check if the address is a multicast address.

Returns: True if the address is a multicast address, false otherwise.

Implements ts::AbstractNetworkAddress.

◆ networkPrefix()

uint64_t ts::IPv6Address::networkPrefix ( ) const

inlineinherited

Get the network prefix (64 most significant bits) of the IPv6 address.

Returns: The network prefix (64 most significant bits) of the IPv6 address.

◆ interfaceIdentifier()

uint64_t ts::IPv6Address::interfaceIdentifier ( ) const

inlineinherited

Get the interface identifier (64 least significant bits) of the IPv6 address.

Returns: The interface identifier (64 least significant bits) of the IPv6 address.

◆ hexlet()

uint16_t ts::IPv6Address::hexlet ( size_t i ) const

inherited

Get one of the 16-bit hexlets in the address.

Parameters

[in] i Hexlet index, from 0 to 7.

Returns: The corresponding hexlet or zero if i is out of range.

◆ match() [2/2]

bool ts::IPv6Address::match ( const IPv6Address & other ) const

inherited

Check if this address "matches" another one.

Parameters

[in] other Another instance to compare.

Returns: False if this and other addresses are both specified and are different. True otherwise.

◆ toBytes()

ByteBlock ts::IPv6Address::toBytes ( ) const

inlineinherited

Get the IP address as a byte block.

Returns: Byte block containing the IPv6 bytes.

◆ operator==() [2/2]

bool ts::IPv6Address::operator== ( const IPv6Address & other ) const

inlineinherited

Equality operator.

Parameters

[in] other Another instance to compare with.

Returns: True if both object contains the same address, false otherwise.

◆ operator<() [2/2]

bool ts::IPv6Address::operator< ( const IPv6Address & other ) const

inlineinherited

Comparison "less than" operator.

It does not really makes sense. Only defined to allow usage in containers.

Parameters

[in] other Other instance to compare.

Returns: True if this instance is less than to other.

◆ hasPort()

virtual bool ts::AbstractNetworkAddress::hasPort ( ) const

virtualinherited

Check if a port is set.

Returns: True if port is set.

◆ clearPort()

virtual void ts::AbstractNetworkAddress::clearPort ( )

virtualinherited

Clear the port.

The default implementatio sets the port to AnyPort

Member Data Documentation

◆ LocalHost

const IPv6Address ts::IPv6Address::LocalHost

staticinherited

Local host address (::1).

Usually resolves to the host name "localhost".

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

tsIPv6SocketAddress.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IPv6SocketAddress() [1/6]

◆ IPv6SocketAddress() [2/6]

◆ IPv6SocketAddress() [3/6]

◆ IPv6SocketAddress() [4/6]

◆ IPv6SocketAddress() [5/6]

◆ IPv6SocketAddress() [6/6]

Member Function Documentation

◆ port()

◆ setPort()

◆ resolve()

◆ toString()

◆ toFullString()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ match() [1/2]

◆ operator==() [1/2]

◆ operator<() [1/2]

◆ binarySize()

◆ familyName()

◆ hasAddress()

◆ getAddress() [1/2]

◆ getAddress() [2/2]

◆ setAddress() [1/4]

◆ setAddress() [2/4]

◆ setAddress() [3/4]

◆ setAddress() [4/4]

◆ clearAddress()

◆ isMulticast()

◆ networkPrefix()

◆ interfaceIdentifier()

◆ hexlet()

◆ match() [2/2]

◆ toBytes()

◆ operator==() [2/2]

◆ operator<() [2/2]

◆ hasPort()

◆ clearPort()

Member Data Documentation

◆ LocalHost