GNU CommonC++
Public Member Functions | Friends | List of all members
ost::IPV4Host Class Reference

This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket. More...

#include <address.h>

Inheritance diagram for ost::IPV4Host:
ost::IPV4Address

Public Member Functions

 IPV4Host (const char *host=NULL)
 Create a new host address for a specific internet host.
 
 IPV4Host (struct in_addr addr)
 Convert a system socket binary address such as may be returned through the accept() call or getsockpeer() into an internet host address object.
 
IPV4Addressoperator= (unsigned long addr)
 Allows assignment from the return of functions like inet_addr() or htonl()
 
IPV4Hostoperator&= (const IPV4Mask &mask)
 Mask the internet host address object with a network mask address.
 
- Public Member Functions inherited from ost::IPV4Address
 IPV4Address (const IPV4Validator *validator=NULL)
 Create an Internet Address object with an empty (0.0.0.0) address.
 
 IPV4Address (struct in_addr addr, const IPV4Validator *validator=NULL)
 Convert the system internet address data type (struct in_addr) into a Common C++ IPV4Address object.
 
 IPV4Address (const char *address, const IPV4Validator *validator=NULL)
 Convert a null terminated ASCII host address string (example: "127.0.0.1") or host address name (example: "www.voxilla.org") directly into a Common C++ IPV4Address object.
 
 IPV4Address (const IPV4Address &rhs)
 Copy constructor.
 
virtual ~IPV4Address ()
 Destructor.
 
const char * getHostname (void) const
 Provide a string representation of the value (Internet Address) held in the IPV4Address object.
 
bool isInetAddress (void) const
 May be used to verify if a given IPV4Address returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" IPV4Address values.
 
struct in_addr getAddress (void) const
 Provide a low level system usable struct in_addr object from the contents of IPV4Address.
 
struct in_addr getAddress (size_t i) const
 Provide a low level system usable struct in_addr object from the contents of IPV4Address.
 
size_t getAddressCount () const
 Returns the number of internet addresses that an IPV4Address object contains.
 
IPV4Addressoperator= (const char *str)
 
IPV4Addressoperator= (struct in_addr addr)
 
IPV4Addressoperator= (const IPV4Address &rhs)
 
IPV4Addressoperator= (unsigned long addr)
 Allows assignment from the return of functions like inet_addr() or htonl()
 
IPV4Addressoperator= (unsigned int addr)
 
bool operator! () const
 
bool operator== (const IPV4Address &a) const
 Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host).
 
bool operator!= (const IPV4Address &a) const
 Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses).
 

Friends

class __EXPORT IPV4Mask
 
__EXPORT IPV4Host operator& (const IPV4Host &addr, const IPV4Mask &mask)
 

Additional Inherited Members

- Protected Member Functions inherited from ost::IPV4Address
bool setIPAddress (const char *host)
 Sets the IP address from a string representation of the numeric address, ie "127.0.0.1".
 
void setAddress (const char *host)
 Used to specify a host name or numeric internet address.
 
- Protected Attributes inherited from ost::IPV4Address
struct in_addr * ipaddr
 
size_t addr_count
 
char * hostname
 
- Static Protected Attributes inherited from ost::IPV4Address
static Mutex mutex
 

Detailed Description

This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket.

Author
David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m

Address of a specific Internet host machine.

Constructor & Destructor Documentation

◆ IPV4Host() [1/2]

ost::IPV4Host::IPV4Host ( const char *  host = NULL)

Create a new host address for a specific internet host.

The internet host can be specified in a null terminated ASCII string and include either the physical host address or the DNS name of a host machine. Hence, an IPV4Host ("www.voxilla.org") can be directly declaired in this manner.

Defaults to the IP address that represents the interface matching "gethostname()".

Parameters
hostdns or physical address of an Internet host.

◆ IPV4Host() [2/2]

ost::IPV4Host::IPV4Host ( struct in_addr  addr)

Convert a system socket binary address such as may be returned through the accept() call or getsockpeer() into an internet host address object.

Parameters
addrbinary address of internet host.

Member Function Documentation

◆ operator&=()

IPV4Host & ost::IPV4Host::operator&= ( const IPV4Mask mask)

Mask the internet host address object with a network mask address.

This is commonly used to coerce an address by subnet.

◆ operator=()

IPV4Address & ost::IPV4Host::operator= ( unsigned long  addr)
inline

Allows assignment from the return of functions like inet_addr() or htonl()

Friends And Related Symbol Documentation

◆ IPV4Mask

friend class __EXPORT IPV4Mask
friend

◆ operator&

__EXPORT IPV4Host operator& ( const IPV4Host addr,
const IPV4Mask mask 
)
friend

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