Public Member Functions | Static Public Member Functions | Protected Attributes

ucc::Socket::address Class Reference

A generic socket address class. More...

#include <socket.h>

Public Member Functions

void add (char *hostname, char *service=NULL, int type=SOCK_STREAM)
 Append additional host addresses to our list.
void add (sockaddr *address)
 Add an individual socket address to our address list.
 address (char *hostname, unsigned service=0)
 Construct a socket address from host and service.
 address (int family, char *address, int type=SOCK_STREAM, int protocol=0)
 Construct a socket address.
 address ()
 Construct an empty address.
 address (int family, char *hostname, char *service=NULL)
 Construct a socket address for an existing socket.
 address (char *host, char *service, int type=SOCK_STREAM)
 Construct a socket address list for a service.
 address (address &reference)
 Copy constructor.
void clear (void)
 Clear current object.
void copy (struct addrinfo *address)
 Copy an existing addrinfo into our object.
struct sockaddr * find (struct sockaddr *addr)
 Find a specific socket address in our address list.
struct sockaddr * get (int family)
 Get the first socket address of specified family from our list.
struct sockaddr * getAddr (void)
 Get the first socket address in our address list.
int getfamily (void)
 Get the family of the first member in a list of services.
struct addrinfo * getList (void)
 Get the full socket address list from the object.
bool insert (struct sockaddr *address)
 Insert an individual socket address to our address list only if unique.
unsigned insert (struct addrinfo *address)
 Insert unique members from another socket address list to ours.
 operator bool ()
 Test if the address list is valid.
 operator struct addrinfo * ()
 Get the full socket address list by casted reference.
 operator struct sockaddr * ()
 Get the first socket address by casted reference.
bool operator! ()
 Test if we have no address list.
struct addrinfo * operator* ()
 Return the full socket address list by pointer reference.
bool remove (struct sockaddr *address)
 Remove an individual socket address from our address list.
unsigned remove (struct addrinfo *address)
 Remove members from another socket address list from ours.
void set (char *hostname, char *service=NULL, int type=SOCK_STREAM)
 Set the host addresses to form a new list.
void set (int family, char *address, int type=SOCK_STREAM, int protocol=0)
 Set an entry for host binding.
void set (char *hostname, unsigned service=0)
 Set a socket address from host and service.
void set (struct sockaddr *address)
 Set an individual socket address for our address list.
 ~address ()
 Destroy address.

Static Public Member Functions

static struct sockaddr * dup (struct sockaddr *address)
 Duplicate a socket address.
static struct sockaddr_in * ipv4 (struct sockaddr *address)
 Convert address object into ipv4 address.
static struct sockaddr_in6 * ipv6 (struct sockaddr *address)
 Convert address object into ipv6 address.

Protected Attributes

struct addrinfo * list

Detailed Description

A generic socket address class.

This class uses the addrinfo list to store socket multiple addresses in a protocol and family independent manner. Hence, this address class can be used for ipv4 and ipv6 sockets, for assigning connections to multiple hosts, etc. The address class will call the resolver when passed host names.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 341 of file socket.h.


Constructor & Destructor Documentation

ucc::Socket::address::address ( int  family,
char *  address,
int  type = SOCK_STREAM,
int  protocol = 0 
)

Construct a socket address.

This is used to get an address to bind a socket interface to. The address can be specified as the ip address of the interface or as a "hostname". If a hostname is used, then family should be specified for clarity.

Parameters:
family of socket address. Needed when host names are used.
address or hostname.
type of socket (stream, dgram, etc).
protocol number of socket.
ucc::Socket::address::address ( int  family,
char *  hostname,
char *  service = NULL 
)

Construct a socket address for an existing socket.

This can be the name of a host or to perform a lookup in a domain for a service. Family can be used to restrict the set of results returned, however since things like connecto() already filter by family and create will use family from the addrinfo, in most cases AF_UNSPEC can be used. This may be depreciated in favor of the constructor that matches a set() method.

Parameters:
family of hosts to filter by or AF_UNSPEC.
hostname or ip address. The socket family is used for hostnames.
service port or name we are referencing or NULL.
ucc::Socket::address::address ( char *  host,
char *  service,
int  type = SOCK_STREAM 
)

Construct a socket address list for a service.

Parameters:
host address for service.
service name or port number.
type of service, stream, dgram, etc.
ucc::Socket::address::address ( char *  hostname,
unsigned  service = 0 
)

Construct a socket address from host and service.

This is primarily used to construct a list of potential service connections by pure port numbers or for host lookup only.

Parameters:
hostname or address to use.
service port or 0.
ucc::Socket::address::address ( address reference  ) 

Copy constructor.

Parameters:
reference to object to copy from.
ucc::Socket::address::~address (  ) 

Destroy address.

Deallocate addrinfo structure.


Member Function Documentation

void ucc::Socket::address::add ( char *  hostname,
char *  service = NULL,
int  type = SOCK_STREAM 
)

Append additional host addresses to our list.

Parameters:
hostname or address to resolve.
service name or port number, or NULL if not used.
type of socket (stream or dgram).
void ucc::Socket::address::add ( sockaddr *  address  ) 

Add an individual socket address to our address list.

Parameters:
address to add.
void ucc::Socket::address::copy ( struct addrinfo *  address  ) 

Copy an existing addrinfo into our object.

This is also used to support the copy constructor.

Parameters:
address list to copy from.
static struct sockaddr* ucc::Socket::address::dup ( struct sockaddr *  address  )  [static, read]

Duplicate a socket address.

Parameters:
address to duplicate.
Returns:
duplicate address object.
struct sockaddr* ucc::Socket::address::find ( struct sockaddr *  addr  )  [read]

Find a specific socket address in our address list.

Returns:
matching address from list or NULL if not found.
struct sockaddr* ucc::Socket::address::get ( int  family  )  [read]

Get the first socket address of specified family from our list.

Parameters:
family to seek.
Returns:
first socket address of family or NULL if none.
struct sockaddr* ucc::Socket::address::getAddr ( void   )  [read]

Get the first socket address in our address list.

Returns:
first socket address or NULL if none.
int ucc::Socket::address::getfamily ( void   ) 

Get the family of the first member in a list of services.

Returns:
family of first socket address or 0 if none.
struct addrinfo* ucc::Socket::address::getList ( void   )  [inline, read]

Get the full socket address list from the object.

Returns:
addrinfo list we resolved or NULL if none.

Definition at line 435 of file socket.h.

unsigned ucc::Socket::address::insert ( struct addrinfo *  address  ) 

Insert unique members from another socket address list to ours.

Parameters:
address list to insert into list.
Returns:
count of addresses added.
bool ucc::Socket::address::insert ( struct sockaddr *  address  ) 

Insert an individual socket address to our address list only if unique.

Parameters:
address to insert into list.
Returns:
true if inserted, false if duplicate.
static struct sockaddr_in* ucc::Socket::address::ipv4 ( struct sockaddr *  address  )  [static, read]

Convert address object into ipv4 address.

Parameters:
address to convert.
Returns:
new ipv4 address or NULL if not ipv4.
static struct sockaddr_in6* ucc::Socket::address::ipv6 ( struct sockaddr *  address  )  [static, read]

Convert address object into ipv6 address.

Parameters:
address to convert.
Returns:
new ipv6 address or NULL if not ipv6.
ucc::Socket::address::operator bool (  )  [inline]

Test if the address list is valid.

Returns:
true if we have an address list.

Definition at line 456 of file socket.h.

ucc::Socket::address::operator struct addrinfo * (  )  [inline]

Get the full socket address list by casted reference.

Returns:
addrinfo list we resolved or NULL if none.

Definition at line 442 of file socket.h.

ucc::Socket::address::operator struct sockaddr * (  )  [inline]

Get the first socket address by casted reference.

Returns:
first socket address we resolved or NULL if none.

Definition at line 470 of file socket.h.

bool ucc::Socket::address::operator! (  )  [inline]

Test if we have no address list.

Returns:
true if we have no address list.

Definition at line 463 of file socket.h.

struct addrinfo* ucc::Socket::address::operator* (  )  [inline, read]

Return the full socket address list by pointer reference.

Returns:
addrinfo list we resolved or NULL if none.

Definition at line 449 of file socket.h.

unsigned ucc::Socket::address::remove ( struct addrinfo *  address  ) 

Remove members from another socket address list from ours.

Parameters:
address list to remove from list.
Returns:
count of addresses removed.
bool ucc::Socket::address::remove ( struct sockaddr *  address  ) 

Remove an individual socket address from our address list.

Parameters:
address to remove.
Returns:
true if found and removed, false if not found.
void ucc::Socket::address::set ( char *  hostname,
char *  service = NULL,
int  type = SOCK_STREAM 
)

Set the host addresses to form a new list.

Parameters:
hostname or address to resolve.
service name or port number, or NULL if not used.
type of socket (stream or dgram) to filter list by.
void ucc::Socket::address::set ( char *  hostname,
unsigned  service = 0 
)

Set a socket address from host and service.

Parameters:
hostname or address to use.
service port or 0.
void ucc::Socket::address::set ( struct sockaddr *  address  ) 

Set an individual socket address for our address list.

Parameters:
address to add.
void ucc::Socket::address::set ( int  family,
char *  address,
int  type = SOCK_STREAM,
int  protocol = 0 
)

Set an entry for host binding.

Parameters:
family of socket address. Needed when hostnames are used.
address or hostname.
type of socket (stream, dgram, etc).
protocol number of socket.

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