pcpp::IPAddress Class Reference

#include <IpAddress.h>

Public Types
enum	AddressType : uint8_t { IPv4AddressType , IPv6AddressType }
	An enum representing the address type: IPv4 or IPv6. More...

Public Member Functions
	IPAddress ()
	A default constructor that creates an instance of the class with unspecified IPv4 address.
	IPAddress (const IPv4Address &addr)
	IPAddress (const IPv6Address &addr)
	IPAddress (const std::string &addrAsString)
IPAddress &	operator= (const IPv4Address &addr)
IPAddress &	operator= (const IPv6Address &addr)
AddressType	getType () const
std::string	toString () const
bool	isIPv4 () const
bool	isIPv6 () const
bool	isMulticast () const
const IPv4Address &	getIPv4 () const
const IPv6Address &	getIPv6 () const
bool	isZero () const
bool	operator== (const IPAddress &rhs) const
bool	operator< (const IPAddress &rhs) const
bool	operator!= (const IPAddress &rhs) const

Detailed Description

The class is a version-independent representation for an IP address

Member Enumeration Documentation

AddressType

enum pcpp::IPAddress::AddressType : uint8_t

An enum representing the address type: IPv4 or IPv6.

Enumerator
IPv4AddressType	IPv4 address type.
IPv6AddressType	IPv6 address type.

Constructor & Destructor Documentation

IPAddress() [1/3]

pcpp::IPAddress::IPAddress ( const IPv4Address &  addr )

inline

A constructor that creates an instance of the class out of IPv4Address.

Parameters

[in]

addr

A const reference to instance of IPv4Address

IPAddress() [2/3]

pcpp::IPAddress::IPAddress ( const IPv6Address &  addr )

inline

A constructor that creates an instance of the class out of IPv6Address.

Parameters

[in]

addr

A const reference to instance of IPv6Address

IPAddress() [3/3]

pcpp::IPAddress::IPAddress

(

const std::string &

addrAsString

)

A constructor that creates an instance of the class out of std::string value

Parameters

[in]

addrAsString

The std::string representation of the address

Exceptions

std::invalid_argument

The provided string does not represent a valid IPv4 or IPv6 address.

Member Function Documentation

getIPv4()

const IPv4Address& pcpp::IPAddress::getIPv4 ( ) const

inline

Get a reference to IPv4 address instance

Returns

The const reference to IPv4Address instance

getIPv6()

const IPv6Address& pcpp::IPAddress::getIPv6 ( ) const

inline

Get a reference to IPv6 address instance

Returns

The const reference to IPv6Address instance

getType()

AddressType pcpp::IPAddress::getType ( ) const

inline

Gets the address type: IPv4 or IPv6

Returns

The address type

isIPv4()

bool pcpp::IPAddress::isIPv4 ( ) const

inline

Returns

Determine whether the object contains an IP version 4 address

isIPv6()

bool pcpp::IPAddress::isIPv6 ( ) const

inline

Returns

Determine whether the object contains an IP version 6 address

isMulticast()

bool pcpp::IPAddress::isMulticast ( ) const

inline

Determine whether the address is a multicast address

Returns

True if an address is multicast

isZero()

bool pcpp::IPAddress::isZero ( ) const

inline

Returns

True if the address is zero, false otherwise

operator!=()

bool pcpp::IPAddress::operator!= ( const IPAddress &  rhs ) const

inline

Overload of the not-equal-to operator

Parameters

[in]

rhs

The object to compare with

Returns

True if the addresses are not equal, false otherwise

operator<()

bool pcpp::IPAddress::operator< ( const IPAddress &  rhs ) const

inline

Overload of the less-than operator

Parameters

[in]

rhs

The object to compare with

Returns

True if the address value is lower than the other address value, false otherwise

operator=() [1/2]

IPAddress & pcpp::IPAddress::operator= ( const IPv4Address &  addr )

inline

Overload of an assignment operator.

Parameters

[in]

addr

A const reference to instance of IPv4Address

Returns

A reference to the assignee

operator=() [2/2]

IPAddress & pcpp::IPAddress::operator= ( const IPv6Address &  addr )

inline

Overload of an assignment operator.

Parameters

[in]

addr

A const reference to instance of IPv6Address

Returns

A reference to the assignee

operator==()

bool pcpp::IPAddress::operator== ( const IPAddress &  rhs ) const

inline

Overload of the equal-to operator

Parameters

[in]

rhs

The object to compare with

Returns

True if the addresses are equal, false otherwise

toString()

std::string pcpp::IPAddress::toString ( ) const

inline

Returns a std::string representation of the address

Returns

A string representation of the address