scim::SocketAddress Class Reference
[SocketCommunication]

The class to hold a socket address. More...

#include <scim_socket.h>

List of all members.

Public Member Functions

 SocketAddress (const String &addr=String())
 Constructor.
 SocketAddress (const SocketAddress &addr)
 Copy constructor.
 ~SocketAddress ()
 Destructor.
const SocketAddressoperator= (const SocketAddress &addr)
 Copy operator.
bool valid () const
 Check if this address is valid.
SocketFamily get_family () const
 Get the family of this socket address.
bool set_address (const String &addr)
 Set a new address.
String get_address () const
 Get the address string.
const void * get_data () const
 Get the internal data of this socket address, used by class Socket.
int get_data_length () const
 Get the size of the internall data.


Detailed Description

The class to hold a socket address.

Class SocketAddress encapsulates the details of socket address, like socketaddr_un and socketaddr_in.

A SocketAddress object can be constructed from an address string, which must start with one of the following prefixes:


Constructor & Destructor Documentation

scim::SocketAddress::SocketAddress ( const String addr = String()  ) 

Constructor.

Parameters:
addr the address string.

scim::SocketAddress::SocketAddress ( const SocketAddress addr  ) 

Copy constructor.

scim::SocketAddress::~SocketAddress (  ) 

Destructor.


Member Function Documentation

const SocketAddress& scim::SocketAddress::operator= ( const SocketAddress addr  ) 

Copy operator.

bool scim::SocketAddress::valid (  )  const

Check if this address is valid.

Returns:
true if this address is valid.

SocketFamily scim::SocketAddress::get_family (  )  const

Get the family of this socket address.

Returns:
the family enum value of this address.
See also:
SocketFamily

bool scim::SocketAddress::set_address ( const String addr  ) 

Set a new address.

Parameters:
addr the new address string.

String scim::SocketAddress::get_address (  )  const

Get the address string.

Returns:
the address string.

const void* scim::SocketAddress::get_data (  )  const

Get the internal data of this socket address, used by class Socket.

Returns:
the pointer to the data, usually a sockaddr struct.

int scim::SocketAddress::get_data_length (  )  const

Get the size of the internall data.

Returns:
the size of the internall data returned by get_data ();


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

Generated on Sat Jan 24 23:45:09 2009 for scim by  doxygen 1.5.7.1