A class for representing an IP address in an OS independent way.
More...
#include <AsyncIpAddress.h>
|
typedef struct in_addr | Ip4Addr |
| The type for the OS specific representation of an IP address. More...
|
|
A class for representing an IP address in an OS independent way.
Definition at line 104 of file AsyncIpAddress.h.
The type for the OS specific representation of an IP address.
Definition at line 110 of file AsyncIpAddress.h.
Async::IpAddress::IpAddress |
( |
void |
| ) |
|
Async::IpAddress::IpAddress |
( |
const std::string & |
addr | ) |
|
Constructor for the IpAddress class.
- Parameters
-
addr | The string representation of an IP address |
Async::IpAddress::IpAddress |
( |
const Ip4Addr & |
addr | ) |
|
Constructor for the IpAddress class.
- Parameters
-
addr | The IP address in OS specific representation |
Async::IpAddress::IpAddress |
( |
const IpAddress & |
addr | ) |
|
|
inline |
Async::IpAddress::~IpAddress |
( |
void |
| ) |
|
|
inline |
void Async::IpAddress::clear |
( |
void |
| ) |
|
|
inline |
Ip4Addr Async::IpAddress::ip4Addr |
( |
void |
| ) |
const |
|
inline |
Return the IP address in OS specific representation.
- Returns
- The IP address
Definition at line 144 of file AsyncIpAddress.h.
bool Async::IpAddress::isEmpty |
( |
void |
| ) |
const |
|
inline |
Check if an invalid IP address has been assigned.
- Returns
- Return true if this is an invalid address or false if a valid address has been assigned.
Definition at line 167 of file AsyncIpAddress.h.
bool Async::IpAddress::isUnicast |
( |
void |
| ) |
const |
Check if this is a unicast IP address.
- Returns
- Return true if this is a unicast address or false if it is some other type.
bool Async::IpAddress::isWithinSubet |
( |
const std::string & |
subnet | ) |
const |
Check if the IP address is within the given netmask.
- Parameters
-
subnet | The subnet to use in the check. The subnet should be given on the form a.b.c.d/m (e.g. 192.168.1.0/24). |
- Returns
- Return true if within the given subnet or false if it is not.
bool Async::IpAddress::operator!= |
( |
const IpAddress & |
rhs | ) |
const |
|
inline |
Unequality operator.
- Parameters
-
rhs | Right hand side expression |
- Returns
- Returns true if the right hand side object is unequal to this object, or else returns false.
Definition at line 215 of file AsyncIpAddress.h.
bool Async::IpAddress::operator< |
( |
const IpAddress & |
rhs | ) |
const |
|
inline |
Less than operator.
- Parameters
-
rhs | Right hand side expression |
- Returns
- Returns true if the right hand side object is less than this object, or else returns false.
Definition at line 226 of file AsyncIpAddress.h.
Assignment operator.
- Parameters
-
rhs | The address object to assign to this object |
- Returns
- Returns the new IP address
Definition at line 192 of file AsyncIpAddress.h.
bool Async::IpAddress::operator== |
( |
const IpAddress & |
rhs | ) |
const |
|
inline |
Equality operator.
- Parameters
-
rhs | Right hand side expression |
- Returns
- Returns true if the right hand side object is equal to this object, or else returns false.
Definition at line 204 of file AsyncIpAddress.h.
bool Async::IpAddress::setIpFromString |
( |
const std::string & |
str | ) |
|
Set the IP address from a string.
- Parameters
-
str | The string to parse (e.g. "192.168.0.1") |
- Returns
- Returns true on success or else false
std::string Async::IpAddress::toString |
( |
void |
| ) |
const |
Return the string representation of the IP address.
- Returns
- The IP address string
Output stream operator.
- Parameters
-
os | The stream to output data to |
ip | The IP address to output to the stream |
Input stream operator.
- Parameters
-
is | The stream to input data from |
ip | The IP address object to store information in |
The documentation for this class was generated from the following file: