CASocketAddrUnix Class Reference

This is a class for Unix Domain Protocol Sockat Addresses. More...

Inheritance diagram for CASocketAddrUnix:

List of all members.

Public Member Functions
	CASocketAddrUnix ()
	Constructs an address with an empty path.
	CASocketAddrUnix (const CASocketAddrUnix &addr)
	Constructs an Unix Adress from an other Unix-Address.
SINT32	getType () const
	Returns the type (family) of the socket this address is for (always AF_LOCAL)
CASocketAddr *	clone () const
	Creates a new copy of this address.
SINT32	getSize () const
	Resturns the size of the SOCKADDR struct used.
const SOCKADDR *	LPSOCKADDR () const
	Makes a cast to SOCKADDR* .
SINT32	setPath (const char *path)
	Sets the path of this unix address.
UINT8 *	getPath () const
	Retruns the path of this address.
virtual SINT32	toString (UINT8 *buff, UINT32 bufflen) const
	Returns a human readable string describing this address.

---

Detailed Description

This is a class for Unix Domain Protocol Sockat Addresses.

---

Constructor & Destructor Documentation

CASocketAddrUnix::CASocketAddrUnix

(

)

Constructs an address with an empty path.

Referenced by clone().

CASocketAddrUnix::CASocketAddrUnix

(

const CASocketAddrUnix &

addr

)

Constructs an Unix Adress from an other Unix-Address.

---

Member Function Documentation

CASocketAddr* CASocketAddrUnix::clone

(

)

const [virtual]

Creates a new copy of this address.

Returns:

a copy of this address

Implements CASocketAddr.

References CASocketAddrUnix().

UINT8 * CASocketAddrUnix::getPath

(

)

const

Retruns the path of this address.

Gets the path for the unix domain protocol address.

Returns:

the path of this address or NULL if not set

The returned char array has to be freed by the caller using delete[].

Return values:

NULL	if path was no specified yet
copy	of the path value

References len.

Referenced by toString().

SINT32 CASocketAddrUnix::getSize

(

)

const [virtual]

Resturns the size of the SOCKADDR struct used.

return sizeof(sockaddr_un)

Implements CASocketAddr.

SINT32 CASocketAddrUnix::getType

(

)

const [virtual]

Returns the type (family) of the socket this address is for (always AF_LOCAL)

Return values:

AF_LOCAL

Implements CASocketAddr.

const SOCKADDR* CASocketAddrUnix::LPSOCKADDR

(

)

const [virtual]

Makes a cast to SOCKADDR* .

Implements CASocketAddr.

SINT32 CASocketAddrUnix::setPath

(

const char *

path

)

Sets the path of this unix address.

Sets the path for the unix domain protocol address.

Parameters:

path	the new path of this address

Return values:

E_SUCCESS	if succesful
E_UNKNOWN	otherwise

Parameters:

path	the new path value (zero terminated)

Return values:

E_SUCCESS	if no error occured
E_UNSPECIFIED	if path was NULL
E_SPACE	if path was to long

References E_SPACE, E_SUCCESS, and E_UNSPECIFIED.

virtual SINT32 CASocketAddrUnix::toString	(	UINT8 *	buff,
		UINT32	bufflen
	)		const [virtual]

Returns a human readable string describing this address.

Parameters:

buff	buffer which holds the string
bufflen	size of the buffer

Return values:

E_SPACE	if the bufvfer is to small for the string
E_UNKNOWN	if an error occured
E_SUCCESS	if successfull

Implements CASocketAddr.

References E_SPACE, E_SUCCESS, E_UNKNOWN, and getPath().