.TH "KNetwork::KResolverEntry" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KNetwork::KResolverEntry \- One resolution entry.  

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

.in +1c
.ti -1c
.RI "\fBKResolverEntry\fP ()"
.br
.ti -1c
.RI "\fBKResolverEntry\fP (const \fBKSocketAddress\fP &addr, int socktype, int protocol, const \fBQString\fP &canonName=QString::null, const \fBQCString\fP &encodedName=\fBQCString\fP())"
.br
.ti -1c
.RI "\fBKResolverEntry\fP (const struct sockaddr *sa, Q_UINT16 salen, int socktype, int protocol, const \fBQString\fP &canonName=QString::null, const \fBQCString\fP &encodedName=\fBQCString\fP())"
.br
.ti -1c
.RI "\fBKResolverEntry\fP (const \fBKResolverEntry\fP &other)"
.br
.ti -1c
.RI "\fB~KResolverEntry\fP ()"
.br
.ti -1c
.RI "\fBKSocketAddress\fP \fBaddress\fP () const "
.br
.ti -1c
.RI "Q_UINT16 \fBlength\fP () const "
.br
.ti -1c
.RI "int \fBfamily\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBcanonicalName\fP () const "
.br
.ti -1c
.RI "\fBQCString\fP \fBencodedName\fP () const "
.br
.ti -1c
.RI "int \fBsocketType\fP () const "
.br
.ti -1c
.RI "int \fBprotocol\fP () const "
.br
.ti -1c
.RI "\fBKResolverEntry\fP & \fBoperator=\fP (const \fBKResolverEntry\fP &other)"
.br
.in -1c
.SH "Detailed Description"
.PP 
One resolution entry. 

This class is one element in the resolution results list. It contains the socket address for connecting, as well as a bit more of information: the socket type, address family and protocol numbers.
.PP
This class contains all the information required for creating, binding and connecting a socket.
.PP
\fBKResolverEntry\fP objects implicitly share data, so copying them is quite efficient.
.PP
\fBAuthor:\fP
.RS 4
Thiago Macieira <thiago.macieira@kdemail.net> 
.RE
.PP

.PP
Definition at line 66 of file kresolver.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KResolverEntry::KResolverEntry ()"
.PP
Default constructor. 
.PP
Definition at line 88 of file kresolver.cpp.
.SS "KResolverEntry::KResolverEntry (const \fBKSocketAddress\fP & addr, int socktype, int protocol, const \fBQString\fP & canonName = \fCQString::null\fP, const \fBQCString\fP & encodedName = \fC\fBQCString\fP()\fP)"
.PP
Constructs a new \fBKResolverEntry\fP from a \fBKSocketAddress\fP and other data. 
.PP
The \fBKSocketAddress\fP \fCaddr\fP parameter will be deep-copied.
.PP
\fBParameters:\fP
.RS 4
\fIaddr\fP the address that was resolved 
.br
\fIsocktype\fP the socket type of the resolved address 
.br
\fIprotocol\fP the protocol of the resolved address 
.br
\fIcanonName\fP the canonical name of the resolved hostname 
.br
\fIencodedName\fP the ASCII-compatible encoding of the hostname 
.RE
.PP

.PP
Definition at line 94 of file kresolver.cpp.
.PP
References encodedName().
.SS "KResolverEntry::KResolverEntry (const struct sockaddr * sa, Q_UINT16 salen, int socktype, int protocol, const \fBQString\fP & canonName = \fCQString::null\fP, const \fBQCString\fP & encodedName = \fC\fBQCString\fP()\fP)"
.PP
Constructs a new \fBKResolverEntry\fP from raw forms of socket addresses and other data. 
.PP
This constructor instead creates an internal \fBKSocketAddress\fP object.
.PP
\fBParameters:\fP
.RS 4
\fIsa\fP the sockaddr structure containing the raw address 
.br
\fIsalen\fP the length of the sockaddr structure 
.br
\fIsocktype\fP the socket type of the resolved address 
.br
\fIprotocol\fP the protocol of the resolved address 
.br
\fIcanonName\fP the canonical name of the resolved hostname 
.br
\fIencodedName\fP the ASCII-compatible encoding of the hostname 
.RE
.PP

.PP
Definition at line 106 of file kresolver.cpp.
.PP
References encodedName().
.SS "KResolverEntry::KResolverEntry (const \fBKResolverEntry\fP & other)"
.PP
Copy constructor. 
.PP
This constructor performs a shallow-copy of the other object. 
.PP
Definition at line 119 of file kresolver.cpp.
.SS "KResolverEntry::~\fBKResolverEntry\fP ()"
.PP
Destructor. 
.PP
The destructor frees associated resources with this object. It does not destroy shared data. 
.PP
Definition at line 126 of file kresolver.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKSocketAddress\fP KResolverEntry::address () const"
.PP
Retrieves the socket address associated with this entry. 
.PP
Definition at line 136 of file kresolver.cpp.
.SS "Q_UINT16 KResolverEntry::length () const"
.PP
Retrieves the length of the socket address structure. 
.PP
Definition at line 142 of file kresolver.cpp.
.PP
References QCString::length().
.SS "int KResolverEntry::family () const"
.PP
Retrieves the family associated with this socket address. 
.PP
Definition at line 148 of file kresolver.cpp.
.SS "\fBQString\fP KResolverEntry::canonicalName () const"
.PP
Retrieves the canonical name associated with this entry, if there is any. 
.PP
If the canonical name was not found, this function returns QString::null. 
.PP
Definition at line 154 of file kresolver.cpp.
.SS "\fBQCString\fP KResolverEntry::encodedName () const"
.PP
Retrieves the encoded domain name associated with this entry, if there is any. 
.PP
If this domain has been resolved through DNS, this will be the the ACE-encoded hostname.
.PP
Returns a null \fBQCString\fP if such information is not available.
.PP
Please note that this information is NOT to be presented to the user, unless requested. 
.PP
Definition at line 160 of file kresolver.cpp.
.PP
Referenced by KResolverEntry().
.SS "int KResolverEntry::socketType () const"
.PP
Retrieves the socket type associated with this entry. 
.PP
Definition at line 166 of file kresolver.cpp.
.SS "int KResolverEntry::protocol () const"
.PP
Retrieves the protocol associated with this entry. 
.PP
Definition at line 172 of file kresolver.cpp.
.SS "\fBKResolverEntry\fP & KResolverEntry::operator= (const \fBKResolverEntry\fP & other)"
.PP
Assignment operator. 
.PP
This function copies the contents of the other object into this one. Data will be shared between the two of them. 
.PP
Definition at line 178 of file kresolver.cpp.

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