CASocketAddrUnix Class Reference

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

#include <CASocketAddrUnix.hpp>

Inheritance diagram for CASocketAddrUnix:

Collaboration diagram for CASocketAddrUnix:

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

Detailed Description

This is a class for Unix Domain Protocol Sockat Addresses.

Definition at line 33 of file CASocketAddrUnix.hpp.

Constructor & Destructor Documentation

CASocketAddrUnix() [1/2]

CASocketAddrUnix::CASocketAddrUnix

(

)

Constructs an address with an empty path.

Definition at line 34 of file CASocketAddrUnix.cpp.

  {
    sun_family=AF_LOCAL;
    memset(sun_path,0,sizeof(sun_path));
  }

References AF_LOCAL.

Referenced by clone().

Here is the caller graph for this function:

CASocketAddrUnix() [2/2]

CASocketAddrUnix::CASocketAddrUnix

(

const CASocketAddrUnix &

addr

)

Constructs an Unix Adress from an other Unix-Address.

Definition at line 41 of file CASocketAddrUnix.cpp.

  {
    sun_family=AF_LOCAL;
    memcpy(sun_path,addr.sun_path,sizeof(sun_path));
  }

References AF_LOCAL.

Member Function Documentation

clone()

CASocketAddr* CASocketAddrUnix::clone ( ) const

inlinevirtual

Creates a new copy of this address.

Returns

a copy of this address

Implements CASocketAddr.

Definition at line 52 of file CASocketAddrUnix.hpp.

          {
            return new CASocketAddrUnix(*this);
          }

References CASocketAddrUnix().

Here is the call graph for this function:

getPath()

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

Definition at line 69 of file CASocketAddrUnix.cpp.

  {
    UINT32 len=strlen(sun_path);
    if(len==0)
      return NULL;
    UINT8* p=new UINT8[len+1];
    strcpy((char*)p,sun_path);
    return p;
  }

References len.

Referenced by toString().

Here is the caller graph for this function:

getSize()

SINT32 CASocketAddrUnix::getSize ( ) const

inlinevirtual

Resturns the size of the SOCKADDR struct used.

return sizeof(sockaddr_un)

Implements CASocketAddr.

Definition at line 61 of file CASocketAddrUnix.hpp.

          {
            return sizeof(sockaddr_un);
          }

getType()

SINT32 CASocketAddrUnix::getType ( ) const

inlinevirtual

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

Return values

AF_LOCAL

Implements CASocketAddr.

Definition at line 42 of file CASocketAddrUnix.hpp.

          {
            return AF_LOCAL;
          }

References AF_LOCAL.

LPSOCKADDR()

const SOCKADDR* CASocketAddrUnix::LPSOCKADDR ( ) const

inlinevirtual

Makes a cast to SOCKADDR* .

Implements CASocketAddr.

Definition at line 67 of file CASocketAddrUnix.hpp.

          {
            return (const ::LPSOCKADDR)(static_cast<const sockaddr_un*>(this));
          }     

setPath()

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

Definition at line 53 of file CASocketAddrUnix.cpp.

  {
    if(path==NULL)
      return E_UNSPECIFIED;
//    ((sockaddr_un*)m_pAddr)->sun_len=strlen(path);
    if(strlen(path)>=sizeof(sun_path))
      return E_SPACE;
    strcpy(sun_path,path);
    return E_SUCCESS;
  }

References E_SPACE, E_SUCCESS, and E_UNSPECIFIED.

toString()

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

inlinevirtual

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.

Definition at line 92 of file CASocketAddrUnix.hpp.

          {
            UINT8* tmppath=getPath();
            if(tmppath==NULL)
              return E_UNKNOWN;
            SINT32 ret=snprintf((char*)buff,bufflen,"Unix address: %s",tmppath);
            delete[]tmppath;
            tmppath = NULL;
            if(ret<0)
              {
                return E_SPACE;
              }
            return E_SUCCESS;
          }

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

Here is the call graph for this function:

---

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

• CASocketAddrUnix.hpp
• CASocketAddrUnix.cpp