ucommon::cidr Class Reference

A class to hold internet segment routing rules. More...

#include <socket.h>

Inheritance diagram for ucommon::cidr:
Inheritance graph
[legend]
Collaboration diagram for ucommon::cidr:
Collaboration graph
[legend]

Public Types

typedef LinkedObject policy
 A convenience type for using a pointer to a linked list as a policy chain.

Public Member Functions

 cidr (const cidr &existing)
 Construct a copy of an existing cidr.
 cidr (policy **policy, const char *string, const char *name)
 Create a named cidr entry on a specified policy chain.
 cidr (policy **policy, const char *string)
 Create an unnamed cidr entry on a specified policy chain.
 cidr (const char *string)
 Create an unlinked cidr from a string.
 cidr ()
 Create an uninitialized cidr.
inethostaddr_t getBroadcast (void) const
 Get the broadcast host address represented by our cidr.
int getFamily (void) const
 Get the address family of our cidr block object.
unsigned getMask (void) const
 Get the number of bits in the cidr bitmask.
const char * getName (void) const
 Get the saved name of our cidr.
inethostaddr_t getNetmask (void) const
 Get the effective network mask for our cidr block.
inethostaddr_t getNetwork (void) const
 Get the network host base address of our cidr block.
bool isMember (const struct sockaddr *address) const
 Test if a given socket address falls within this cidr.
bool operator!= (const struct sockaddr *address) const
 Test if a given socket address falls outside this cidr.
bool operator== (const struct sockaddr *address) const
 Test if a given socket address falls within this cidr.
void set (const char *string)
 Set our cidr to a string address.

Static Public Member Functions

static cidrcontainer (policy *policy, const struct sockaddr *address)
 Get the largest container cidr entry in a list that matches the socket address.
static cidrfind (policy *policy, const struct sockaddr *address)
 Find the smallest cidr entry in a list that matches the socket address.

Protected Member Functions

unsigned getMask (const char *cp) const

Protected Attributes

int family
char name [16]
inethostaddr_t netmask
inethostaddr_t network

Detailed Description

A class to hold internet segment routing rules.

This class can be used to provide a stand-alone representation of a cidr block of internet addresses or chained together into some form of access control list. The cidr class can hold segments for both IPV4 and IPV6 addresses. The class accepts cidr's defined as C strings, typically in the form of address/bits or address/submask. These routines auto-detect ipv4 and ipv6 addresses.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 156 of file socket.h.


Constructor & Destructor Documentation

ucommon::cidr::cidr ( const char *  string  ) 

Create an unlinked cidr from a string.

The string is typically in the form base-host-address/range, where range might be a bit count or a network mask.

Parameters:
string for cidr block.
ucommon::cidr::cidr ( policy **  policy,
const char *  string 
)

Create an unnamed cidr entry on a specified policy chain.

Parameters:
policy chain to link cidr to.
string for cidr block.
ucommon::cidr::cidr ( policy **  policy,
const char *  string,
const char *  name 
)

Create a named cidr entry on a specified policy chain.

Parameters:
policy chain to link cidr to.
string for cidr block.
name of this policy object.
ucommon::cidr::cidr ( const cidr existing  ) 

Construct a copy of an existing cidr.

Parameters:
existing cidr we copy from.

Member Function Documentation

static cidr* ucommon::cidr::container ( policy policy,
const struct sockaddr *  address 
) [static]

Get the largest container cidr entry in a list that matches the socket address.

Parameters:
policy chain to search.
address to search for.
Returns:
largest cidr or NULL if none match.
static cidr* ucommon::cidr::find ( policy policy,
const struct sockaddr *  address 
) [static]

Find the smallest cidr entry in a list that matches the socket address.

Parameters:
policy chain to search.
address to search for.
Returns:
smallest cidr or NULL if none match.
inethostaddr_t ucommon::cidr::getBroadcast ( void   )  const

Get the broadcast host address represented by our cidr.

Returns:
binary broadcast host address.
int ucommon::cidr::getFamily ( void   )  const [inline]

Get the address family of our cidr block object.

Returns:
family of our cidr.

Definition at line 235 of file socket.h.

unsigned ucommon::cidr::getMask ( void   )  const

Get the number of bits in the cidr bitmask.

Returns:
bit mask of cidr.
const char* ucommon::cidr::getName ( void   )  const [inline]

Get the saved name of our cidr.

This is typically used with find when the same policy name might be associated with multiple non- overlapping cidr blocks. A typical use might to have a cidr block like 127/8 named "localdomain", as well as the ipv6 "::1".

Returns:
name of cidr.

Definition at line 228 of file socket.h.

inethostaddr_t ucommon::cidr::getNetmask ( void   )  const [inline]

Get the effective network mask for our cidr block.

Returns:
binary network mask for our cidr.

Definition at line 249 of file socket.h.

inethostaddr_t ucommon::cidr::getNetwork ( void   )  const [inline]

Get the network host base address of our cidr block.

Returns:
binary network host address.

Definition at line 242 of file socket.h.

bool ucommon::cidr::isMember ( const struct sockaddr *  address  )  const

Test if a given socket address falls within this cidr.

Parameters:
address of socket to test.
Returns:
true if address is within cidr.
bool ucommon::cidr::operator!= ( const struct sockaddr *  address  )  const [inline]

Test if a given socket address falls outside this cidr.

Parameters:
address of socket to test.
Returns:
true if address is outside cidr.

Definition at line 290 of file socket.h.

Here is the call graph for this function:

bool ucommon::cidr::operator== ( const struct sockaddr *  address  )  const [inline]

Test if a given socket address falls within this cidr.

Parameters:
address of socket to test.
Returns:
true if address is within cidr.

Definition at line 282 of file socket.h.

Here is the call graph for this function:

void ucommon::cidr::set ( const char *  string  ) 

Set our cidr to a string address.

Replaces prior value.

Parameters:
string to set for cidr.

The documentation for this class was generated from the following file:
Generated on Thu Jul 14 16:34:58 2011 for ucommon by  doxygen 1.6.3