Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ost_ipv4cidr(3) [debian man page]

ost::IPV4Cidr(3)					     Library Functions Manual						  ost::IPV4Cidr(3)

NAME

       ost::IPV4Cidr -

       The CIDR class is used to support routing tables and validate address policies.

SYNOPSIS

       #include <address.h>

   Public Member Functions
       struct in_addr getNetwork (void) const
	   Get network address associated with this cidr.
       struct in_addr getNetmask (void) const
	   Get network mask associated with this cidr.
       struct in_addr getBroadcast (void) const
	   Compute the broadcast address associated with this cidr.
       void set (const char *cidr)
	   Set the cidr from a full or partial hostname, or from an address/mask, or a host/bits specification.
       IPV4Cidr (const char *cidr)
	   Construct a new cidr from a string.
       IPV4Cidr ()
	   Construct an empty cidr.
       IPV4Cidr (IPV4Cidr &)
	   Construct a copy of a cidr.
       bool isMember (const struct sockaddr *saddr) const
	   See if a socket address is a member of this cidr's network.
       bool isMember (const struct in_addr &inaddr) const
	   See if a low level address object is a member of this cidr's net.
       bool operator== (const struct sockaddr *a) const
       bool operator== (const struct in_addr &a) const

   Protected Member Functions
       unsigned getMask (const char *cp) const

   Protected Attributes
       struct in_addr netmask network

Detailed Description
       The CIDR class is used to support routing tables and validate address policies.

       Author:
	   David Sugar dyfet@gnutelephony.org Classless Internet Domain Routing

Constructor &; Destructor Documentation
   ost::IPV4Cidr::IPV4Cidr (const char *cidr)
       Construct a new cidr from a string. Parameters:
	   cidr string to use.

   ost::IPV4Cidr::IPV4Cidr ()
       Construct an empty cidr.

   ost::IPV4Cidr::IPV4Cidr (IPV4Cidr &)
       Construct a copy of a cidr. Parameters:
	   cidr to copy from.

Member Function Documentation
   struct in_addr ost::IPV4Cidr::getBroadcast (void) const [read]
       Compute the broadcast address associated with this cidr. Returns:
	   system binary coded network address.

   unsigned ost::IPV4Cidr::getMask (const char *cp) const [protected]
   struct in_addr ost::IPV4Cidr::getNetmask (void) const [inline],  [read]
       Get network mask associated with this cidr. Returns:
	   system binary coded network mask.

   struct in_addr ost::IPV4Cidr::getNetwork (void) const [inline],  [read]
       Get network address associated with this cidr. Returns:
	   system binary coded address.

   bool ost::IPV4Cidr::isMember (const struct sockaddr *saddr) const
       See if a socket address is a member of this cidr's network. Parameters:
	   saddr pointer to test.

       Returns:
	   true if member of cidr.

   bool ost::IPV4Cidr::isMember (const struct in_addr &inaddr) const
       See if a low level address object is a member of this cidr's net. Parameters:
	   inaddr object to test.

       Returns:
	   true if member of cidr.

   bool ost::IPV4Cidr::operator== (const struct sockaddr *a) const [inline]
   bool ost::IPV4Cidr::operator== (const struct in_addr &a) const [inline]
   void ost::IPV4Cidr::set (const char *cidr)
       Set the cidr from a full or partial hostname, or from an address/mask, or a host/bits specification. Parameters:
	   cidr string to use.

Member Data Documentation
   struct in_addr netmask ost::IPV4Cidr::network [protected]
Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012						  ost::IPV4Cidr(3)

Check Out this Related Man Page

ost::IPV4Host(3)					     Library Functions Manual						  ost::IPV4Host(3)

NAME

       ost::IPV4Host -

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

SYNOPSIS

       #include <address.h>

       Inherits 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.
       IPV4Address & operator= (unsigned long addr)
	   Allows assignment from the return of functions like inet_addr() or htonl()
       IPV4Host & operator&= (const IPV4Mask &mask)
	   Mask the internet host address object with a network mask address.

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

   Additional Inherited Members
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@ostel.com Address of a specific Internet host machine.

Constructor &; Destructor Documentation
   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:
	   host dns or physical address of an Internet host.

   ost::IPV4Host::IPV4Host (struct in_addraddr)
       Convert a system socket binary address such as may be returned through the accept() call or getsockpeer() into an internet host address
       object. Parameters:
	   addr binary address of internet host.

Member Function Documentation
   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.

   IPV4Address& ost::IPV4Host::operator= (unsigned longaddr) [inline]
       Allows assignment from the return of functions like inet_addr() or htonl()

       Reimplemented from ost::IPV4Address.

       References ost::IPV4Address::operator=().

Friends And Related Function Documentation
   friend class __EXPORT IPV4Mask [friend]
   __EXPORT IPV4Host operator& (const IPV4Host &addr, const IPV4Mask &mask) [friend]
Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012						  ost::IPV4Host(3)
Man Page