.TH "KUnixSocketAddress" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KUnixSocketAddress \- A Unix socket address a Unix socket address.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ksockaddr.h>\fP
.PP
Inherits \fBKSocketAddress\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKUnixSocketAddress\fP ()"
.br
.ti -1c
.RI "\fBKUnixSocketAddress\fP (const sockaddr_un *raw_data, ksocklen_t size)"
.br
.ti -1c
.RI "\fBKUnixSocketAddress\fP (\fBQCString\fP pathname)"
.br
.ti -1c
.RI "virtual \fB~KUnixSocketAddress\fP ()"
.br
.ti -1c
.RI "bool \fBsetAddress\fP (const sockaddr_un *socket_address, ksocklen_t size)"
.br
.ti -1c
.RI "bool \fBsetAddress\fP (\fBQCString\fP path)"
.br
.ti -1c
.RI "\fBQCString\fP \fBpathname\fP () const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBpretty\fP () const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBserviceName\fP () const "
.br
.ti -1c
.RI "const sockaddr_un * \fBaddress\fP () const "
.br
.ti -1c
.RI "\fBoperator const sockaddr_un *\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static bool \fBareEqualUnix\fP (const \fBKSocketAddress\fP &s1, const \fBKSocketAddress\fP &s2, bool coreOnly)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKExtendedSocket\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A Unix socket address a Unix socket address. 

This is a Unix socket address.
.PP
This class expects \fBQCString\fP instead of \fBQString\fP values, which means the filenames should be encoded in whatever form locale/system deems necessary before passing down to the function
.PP
\fBAuthor:\fP
.RS 4
Thiago Macieira <thiago.macieira@kdemail.net> 
.RE
.PP

.PP
Definition at line 584 of file ksockaddr.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KUnixSocketAddress::KUnixSocketAddress ()"
.PP
Default constructor. 
.PP
Definition at line 741 of file ksockaddr.cpp.
.SS "KUnixSocketAddress::KUnixSocketAddress (const sockaddr_un * raw_data, ksocklen_t size)"
.PP
Constructor from raw data. 
.PP
\fBParameters:\fP
.RS 4
\fIraw_data\fP raw data 
.br
\fIsize\fP data length 
.RE
.PP

.PP
Definition at line 746 of file ksockaddr.cpp.
.PP
References setAddress().
.SS "KUnixSocketAddress::KUnixSocketAddress (\fBQCString\fP pathname)"
.PP
Constructor from pathname. 
.PP
\fBParameters:\fP
.RS 4
\fIpathname\fP pathname 
.RE
.PP

.PP
Definition at line 752 of file ksockaddr.cpp.
.PP
References setAddress().
.SS "KUnixSocketAddress::~\fBKUnixSocketAddress\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 758 of file ksockaddr.cpp.
.SH "Member Function Documentation"
.PP 
.SS "bool KUnixSocketAddress::setAddress (const sockaddr_un * socket_address, ksocklen_t size)"
.PP
Sets this to given sockaddr_un. 
.PP
\fBParameters:\fP
.RS 4
\fIsocket_address\fP socket address 
.br
\fIsize\fP the socket length 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP

.PP
Definition at line 763 of file ksockaddr.cpp.
.PP
Referenced by KUnixSocketAddress().
.SS "bool KUnixSocketAddress::setAddress (\fBQCString\fP path)"
.PP
Sets this to given pathname. 
.PP
\fBParameters:\fP
.RS 4
\fIpath\fP pathname 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP

.PP
Definition at line 802 of file ksockaddr.cpp.
.PP
References QCString::length().
.SS "\fBQCString\fP KUnixSocketAddress::pathname () const"
.PP
Returns the pathname. 
.PP
\fBReturns:\fP
.RS 4
the pathname, can be QCString::null if uninitialized, or '' if unknown 
.RE
.PP

.PP
Definition at line 838 of file ksockaddr.cpp.
.PP
Referenced by pretty(), and serviceName().
.SS "\fBQString\fP KUnixSocketAddress::pretty () const\fC [virtual]\fP"
.PP
Returns pretty representation of this socket. 
.PP
\fBReturns:\fP
.RS 4
a pretty text representation of the socket. 
.RE
.PP

.PP
Reimplemented from \fBKSocketAddress\fP.
.PP
Definition at line 849 of file ksockaddr.cpp.
.PP
References QFile::decodeName(), QCString::isEmpty(), and pathname().
.SS "\fBQString\fP KUnixSocketAddress::serviceName () const\fC [virtual]\fP"
.PP
Returns the service name for this socket, as KExtendedSocket::lookup expects as the service argument. 
.PP
In the case of Internet sockets, this is the port number. The default implementation returns QString::null. 
.PP
\fBReturns:\fP
.RS 4
the service name, can be QString::null 
.RE
.PP

.PP
Reimplemented from \fBKSocketAddress\fP.
.PP
Definition at line 857 of file ksockaddr.cpp.
.PP
References QString::fromUtf8(), and pathname().
.SS "const sockaddr_un * KUnixSocketAddress::address () const"
.PP
Returns raw socket address. 
.PP
\fBReturns:\fP
.RS 4
the raw socket address (can be 0 if uninitialized) 
.RE
.PP

.PP
Reimplemented from \fBKSocketAddress\fP.
.PP
Definition at line 862 of file ksockaddr.cpp.
.SS "KUnixSocketAddress::operator const sockaddr_un * () const\fC [inline]\fP"
.PP
Returns raw socket address. 
.PP
\fBReturns:\fP
.RS 4
the raw socket address (can be 0 if uninitialized) 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBaddress()\fP 
.RE
.PP

.PP
Definition at line 658 of file ksockaddr.h.
.PP
References KSocketAddress::address().
.SS "bool KUnixSocketAddress::areEqualUnix (const \fBKSocketAddress\fP & s1, const \fBKSocketAddress\fP & s2, bool coreOnly)\fC [static]\fP"
.PP
Compares two unix socket addresses. 
.PP
\fBParameters:\fP
.RS 4
\fIs1\fP the first address to compare 
.br
\fIs2\fP the second address to compare 
.br
\fIcoreOnly\fP true if only core parts should be compared (currently unused) 
.RE
.PP
\fBReturns:\fP
.RS 4
true if the given addresses are equal. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKSocketAddress::isEqual()\fP 
.PP
\fBKSocketAddress::isCoreEqual()\fP 
.RE
.PP

.PP
Definition at line 867 of file ksockaddr.cpp.
.PP
Referenced by KSocketAddress::isCoreEqual(), and KSocketAddress::isEqual().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
