IPv4 address implementation. More...

Inheritance diagram for join::Ipv4Address:

Collaboration diagram for join::Ipv4Address:

Public Member Functions
	Ipv4Address ()
	create the Ipv4Address instance.

	Ipv4Address (const Ipv4Address &address)
	create the Ipv4Address instance by copy.

Ipv4Address &	operator= (const Ipv4Address &address)
	copy the Ipv4Address instance.

	Ipv4Address (const void *address)
	create the Ipv4Address instance using IPv4 address structure.

	Ipv4Address (int prefix)
	create netmask address using prefix.

	~Ipv4Address ()
	destroy the Ipv4Address instance.

int	family () const
	get address family.

const void *	addr () const
	get the internal address structure.

socklen_t	length () const
	get the size in byte of the internal address structure.

uint32_t	scope () const
	get the scope identifier of the address.

int	prefix () const
	get prefix length from netmask address.

bool	isWildcard () const
	check if IP address is

bool	isLoopBack () const
	check if IP address is a loopback address.

bool	isLinkLocal () const
	check if IP address is link local.

bool	isSiteLocal () const
	check if IP address is site local (deprecated).

bool	isUniqueLocal () const
	check if IP address is unique local.

bool	isBroadcast (int prefix) const
	check if IP address is a broadcast address.

bool	isMulticast () const
	check if IP address is multicast.

bool	isIpv4Compat () const
	check if IP address is IPv4 compatible (deprecated).

bool	isIpv4Mapped () const
	check if IP address is IPv4 mapped.

std::string	toString () const
	convert internal address structure to string.

std::string	toArpa () const
	convert IP address to the in-addr.arpa domain name.

Ipv4Address	operator& (const Ipv4Address &address) const
	perform AND operation on IP address.

Ipv4Address	operator\| (const Ipv4Address &address) const
	perform OR operation on IP address.

Ipv4Address	operator^ (const Ipv4Address &address) const
	perform XOR operation on IP address.

Ipv4Address	operator~ () const
	perform NOT operation on IP address.

void	clear ()
	clear IP address (wilcard address).

uint8_t &	operator[] (size_t position)
	returns a reference to the element at the specified location.

Public Member Functions inherited from join::IpAddressImpl
virtual	~IpAddressImpl ()
	destroy the IpAddressImpl instance.

Static Public Member Functions
static bool	parse (const std::string &address, Ipv4Address &ip)
	parse an IPv4 address in string format.

Additional Inherited Members
Protected Member Functions inherited from join::IpAddressImpl
	IpAddressImpl ()
	create the IpAddressImpl instance.

	IpAddressImpl (const IpAddressImpl &address)=delete
	create the IpAddressImpl instance by copy.

Detailed Description

IPv4 address implementation.

Constructor & Destructor Documentation

◆ Ipv4Address() [1/4]

join::Ipv4Address::Ipv4Address ( )

inline

create the Ipv4Address instance.

◆ Ipv4Address() [2/4]

join::Ipv4Address::Ipv4Address ( const Ipv4Address & address )

inline

create the Ipv4Address instance by copy.

Parameters

address address to copy.

◆ Ipv4Address() [3/4]

join::Ipv4Address::Ipv4Address ( const void * address )

inline

create the Ipv4Address instance using IPv4 address structure.

Parameters

address address structure to use.

◆ Ipv4Address() [4/4]

join::Ipv4Address::Ipv4Address ( int prefix )

inline

create netmask address using prefix.

Parameters

prefix number of bits to create the netmask address from.

◆ ~Ipv4Address()

join::Ipv4Address::~Ipv4Address ( )

inline

destroy the Ipv4Address instance.

Member Function Documentation

◆ addr()

const void * join::Ipv4Address::addr ( ) const

inlinevirtual

get the internal address structure.

Returns: the internal address structure.

Implements join::IpAddressImpl.

◆ clear()

void join::Ipv4Address::clear ( )

inlinevirtual

clear IP address (wilcard address).

Implements join::IpAddressImpl.

◆ family()

int join::Ipv4Address::family ( ) const

inlinevirtual

get address family.

Returns: AF_INET if IPv4, AF_INET6 if IPv6.

Implements join::IpAddressImpl.

◆ isBroadcast()

bool join::Ipv4Address::isBroadcast ( int prefix ) const

inlinevirtual

check if IP address is a broadcast address.

Parameters

prefix prefix length.

Returns: if broadcast true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ isIpv4Compat()

bool join::Ipv4Address::isIpv4Compat ( ) const

inlinevirtual

check if IP address is IPv4 compatible (deprecated).

Returns: if IPv4 compatible true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ isIpv4Mapped()

bool join::Ipv4Address::isIpv4Mapped ( ) const

inlinevirtual

check if IP address is IPv4 mapped.

Returns: if IPv4 mapped true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ isLinkLocal()

bool join::Ipv4Address::isLinkLocal ( ) const

inlinevirtual

check if IP address is link local.

Returns: if IP address is link local true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ isLoopBack()

bool join::Ipv4Address::isLoopBack ( ) const

inlinevirtual

check if IP address is a loopback address.

Returns: if loopback true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ isMulticast()

bool join::Ipv4Address::isMulticast ( ) const

inlinevirtual

check if IP address is multicast.

Returns: if multicast true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ isSiteLocal()

bool join::Ipv4Address::isSiteLocal ( ) const

inlinevirtual

check if IP address is site local (deprecated).

Returns: if IP address is site local true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ isUniqueLocal()

bool join::Ipv4Address::isUniqueLocal ( ) const

inlinevirtual

check if IP address is unique local.

Returns: if IP address is unique local true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ isWildcard()

bool join::Ipv4Address::isWildcard ( ) const

inlinevirtual

check if IP address is

Returns: if wildcard true is returned, false otherwise.

Implements join::IpAddressImpl.

◆ length()

socklen_t join::Ipv4Address::length ( ) const

inlinevirtual

get the size in byte of the internal address structure.

Returns: the size in byte of the internal address structure.

Implements join::IpAddressImpl.

◆ operator&()

Ipv4Address join::Ipv4Address::operator& ( const Ipv4Address & address ) const

inline

perform AND operation on IP address.

Parameters

address address to compare.

Returns: result of AND operation on IpAddress.

◆ operator=()

Ipv4Address & join::Ipv4Address::operator= ( const Ipv4Address & address )

inline

copy the Ipv4Address instance.

Parameters

address address to copy.

◆ operator[]()

uint8_t & join::Ipv4Address::operator[] ( size_t position )

inlinevirtual

returns a reference to the element at the specified location.

Parameters

position position of the element to return.

Returns: reference to the requested element.

Exceptions

invalid_argument if position is out of range.

Implements join::IpAddressImpl.

◆ operator^()

Ipv4Address join::Ipv4Address::operator^ ( const Ipv4Address & address ) const

inline

perform XOR operation on IP address.

Parameters

address address to compare.

Returns: result of XOR operation on IpAddress.

◆ operator|()

Ipv4Address join::Ipv4Address::operator| ( const Ipv4Address & address ) const

inline

perform OR operation on IP address.

Parameters

address Address to compare.

Returns: result of OR operation on IpAddress.

◆ operator~()

Ipv4Address join::Ipv4Address::operator~ ( ) const

inline

perform NOT operation on IP address.

Returns: result of NOT operation on IpAddress.

◆ parse()

static bool join::Ipv4Address::parse	(	const std::string &	address,
		Ipv4Address &	ip )

inlinestatic

parse an IPv4 address in string format.

Parameters

address	address string to use.
ip	IP address output.

Returns: true on success, false otherwise.

◆ prefix()

int join::Ipv4Address::prefix ( ) const

inlinevirtual

get prefix length from netmask address.

Returns: prefix length.

Implements join::IpAddressImpl.

◆ scope()

uint32_t join::Ipv4Address::scope ( ) const

inlinevirtual

get the scope identifier of the address.

Returns: the scope identifier of the address.

Implements join::IpAddressImpl.

◆ toArpa()

std::string join::Ipv4Address::toArpa ( ) const

inlinevirtual

convert IP address to the in-addr.arpa domain name.

Returns: the converted IP address.

Implements join::IpAddressImpl.

◆ toString()

std::string join::Ipv4Address::toString ( ) const

inlinevirtual

convert internal address structure to string.

Returns: the internal address structure converted to string.

Implements join::IpAddressImpl.

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

core/src/ipaddress.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ipv4Address() [1/4]

◆ Ipv4Address() [2/4]

◆ Ipv4Address() [3/4]

◆ Ipv4Address() [4/4]

◆ ~Ipv4Address()

Member Function Documentation

◆ addr()

◆ clear()

◆ family()

◆ isBroadcast()

◆ isIpv4Compat()

◆ isIpv4Mapped()

◆ isLinkLocal()

◆ isLoopBack()

◆ isMulticast()

◆ isSiteLocal()

◆ isUniqueLocal()

◆ isWildcard()

◆ length()

◆ operator&()

◆ operator=()

◆ operator[]()

◆ operator^()

◆ operator|()

◆ operator~()

◆ parse()

◆ prefix()

◆ scope()

◆ toArpa()

◆ toString()