KUnixSocketAddress Class Reference

A Unix socket address. More...

#include <ksockaddr.h>

Inheritance diagram for KUnixSocketAddress:

[legend]

List of all members.

Public Member Functions
const sockaddr_un *	address () const
	KUnixSocketAddress (QCString pathname)
	KUnixSocketAddress (const sockaddr_un *raw_data, ksocklen_t size)
	KUnixSocketAddress ()
	operator const sockaddr_un * () const
QCString	pathname () const
virtual QString	pretty () const
virtual QString	serviceName () const
bool	setAddress (QCString path)
bool	setAddress (const sockaddr_un *socket_address, ksocklen_t size)
virtual	~KUnixSocketAddress ()
Static Public Member Functions
static bool	areEqualUnix (const KSocketAddress &s1, const KSocketAddress &s2, bool coreOnly)
Protected Member Functions
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

A Unix socket address.

This is a Unix socket address.

This class expects QCString instead of QString values, which means the filenames should be encoded in whatever form locale/system deems necessary before passing down to the function

Author:

Thiago Macieira <thiago.macieira@kdemail.net> a Unix socket address

Definition at line 584 of file ksockaddr.h.

---

Constructor & Destructor Documentation

KUnixSocketAddress::KUnixSocketAddress

(

)

Default constructor.

Definition at line 741 of file ksockaddr.cpp.

KUnixSocketAddress::KUnixSocketAddress	(	const sockaddr_un *	raw_data,
		ksocklen_t	size
	)

Constructor from raw data.

Parameters:

	raw_data	raw data
	size	data length

Definition at line 746 of file ksockaddr.cpp.

KUnixSocketAddress::KUnixSocketAddress

(

QCString

pathname

)

Constructor from pathname.

Parameters:

pathname

pathname

Definition at line 752 of file ksockaddr.cpp.

KUnixSocketAddress::~KUnixSocketAddress

(

)

[virtual]

Destructor.

Definition at line 758 of file ksockaddr.cpp.

---

Member Function Documentation

const sockaddr_un * KUnixSocketAddress::address

(

)

const

Returns raw socket address.

Returns:

the raw socket address (can be 0 if uninitialized)

Reimplemented from KSocketAddress.

Definition at line 862 of file ksockaddr.cpp.

bool KUnixSocketAddress::areEqualUnix	(	const KSocketAddress &	s1,
		const KSocketAddress &	s2,
		bool	coreOnly
	)			[static]

Compares two unix socket addresses.

Parameters:

	s1	the first address to compare
	s2	the second address to compare
	coreOnly	true if only core parts should be compared (currently unused)

Returns:

true if the given addresses are equal.

See also:

KSocketAddress::isEqual()

KSocketAddress::isCoreEqual()

Definition at line 867 of file ksockaddr.cpp.

KUnixSocketAddress::operator const sockaddr_un *

(

)

const [inline]

Returns raw socket address.

Returns:

the raw socket address (can be 0 if uninitialized)

See also:

address()

Definition at line 658 of file ksockaddr.h.

QCString KUnixSocketAddress::pathname

(

)

const

Returns the pathname.

Returns:

the pathname, can be QCString::null if uninitialized, or "" if unknown

Definition at line 838 of file ksockaddr.cpp.

QString KUnixSocketAddress::pretty

(

)

const [virtual]

Returns pretty representation of this socket.

Returns:

a pretty text representation of the socket.

Reimplemented from KSocketAddress.

Definition at line 849 of file ksockaddr.cpp.

QString KUnixSocketAddress::serviceName

(

)

const [virtual]

Returns the service name for this socket, as KExtendedSocket::lookup expects as the service argument.

In the case of Internet sockets, this is the port number. The default implementation returns QString::null.

Returns:

the service name, can be QString::null

Reimplemented from KSocketAddress.

Definition at line 857 of file ksockaddr.cpp.

bool KUnixSocketAddress::setAddress

(

QCString

path

)

Sets this to given pathname.

Parameters:

path

pathname

Returns:

true if successful, false otherwise

Definition at line 802 of file ksockaddr.cpp.

bool KUnixSocketAddress::setAddress	(	const sockaddr_un *	socket_address,
		ksocklen_t	size
	)

Sets this to given sockaddr_un.

Parameters:

	socket_address	socket address
	size	the socket length

Returns:

true if successful, false otherwise

Definition at line 763 of file ksockaddr.cpp.

void KUnixSocketAddress::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KSocketAddress.

Definition at line 890 of file ksockaddr.cpp.

---

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

• ksockaddr.h
• ksockaddr.cpp