Async  0.18.0
Public Types | Public Member Functions | Friends
Async::IpAddress Class Reference

A class for representing an IP address in an OS independent way. More...

#include <AsyncIpAddress.h>

List of all members.

Public Types

Public Member Functions

Friends


Detailed Description

A class for representing an IP address in an OS independent way.

Examples:

AsyncUdpSocket_demo.cpp.


Member Typedef Documentation

typedef struct in_addr Async::IpAddress::Ip4Addr

The type for the OS specific representation of an IP address.

Definition at line 110 of file AsyncIpAddress.h.


Constructor & Destructor Documentation

Async::IpAddress::IpAddress ( void  )

Default constructor for the IpAddress class.

Async::IpAddress::IpAddress ( const std::string &  addr)

Constructor for the IpAddress class.

Parameters:
addrThe string representation of an IP address
Async::IpAddress::IpAddress ( const Ip4Addr addr)

Constructor for the IpAddress class.

Parameters:
addrThe IP address in OS specific representation
Async::IpAddress::IpAddress ( const IpAddress addr) [inline]

Copy contructor.

Parameters:
addrAn IpAddress object to construct the new object from

Definition at line 133 of file AsyncIpAddress.h.

Async::IpAddress::~IpAddress ( void  ) [inline]

Destructor.

Definition at line 138 of file AsyncIpAddress.h.


Member Function Documentation

void Async::IpAddress::clear ( void  ) [inline]

Invalidate the IP address value.

Definition at line 172 of file AsyncIpAddress.h.

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:
subnetThe 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:
rhsRight hand side expression
Returns:
Returns true if the right hand side object is unequal to this object, or else returns false.

Definition at line 208 of file AsyncIpAddress.h.

bool Async::IpAddress::operator< ( const IpAddress rhs) const [inline]

Less than operator.

Parameters:
rhsRight hand side expression
Returns:
Returns true if the right hand side object is less than this object, or else returns false.

Definition at line 219 of file AsyncIpAddress.h.

IpAddress& Async::IpAddress::operator= ( const IpAddress rhs) [inline]

Assignment operator.

Parameters:
rhsThe address object to assign to this object
Returns:
Returns the new IP address

Definition at line 185 of file AsyncIpAddress.h.

bool Async::IpAddress::operator== ( const IpAddress rhs) const [inline]

Equality operator.

Parameters:
rhsRight hand side expression
Returns:
Returns true if the right hand side object is equal to this object, or else returns false.

Definition at line 197 of file AsyncIpAddress.h.

std::string Async::IpAddress::toString ( void  ) const

Return the string representation of the IP address.

Returns:
The IP address string
Examples:
AsyncTcpServer_demo.cpp.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const Async::IpAddress ip 
) [friend]

Output stream operator.

Parameters:
osThe stream to output data to
ipThe IP address to output to the stream

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