KNetwork::KInetSocketAddress

KNetwork::KInetSocketAddress Class Reference

#include <k3socketaddress.h>

Inheritance diagram for KNetwork::KInetSocketAddress:

Public Member Functions

 KInetSocketAddress ()
 
 KInetSocketAddress (const sockaddr *sa, quint16 len)
 
 KInetSocketAddress (const KIpAddress &host, quint16 port)
 
 KInetSocketAddress (const KInetSocketAddress &other)
 
 KInetSocketAddress (const KSocketAddress &other)
 
virtual ~KInetSocketAddress ()
 
quint32 flowinfo () const
 
KIpAddress ipAddress () const
 
int ipVersion () const
 
KInetSocketAddressmakeIPv4 ()
 
KInetSocketAddressmakeIPv6 ()
 
 operator const sockaddr_in * () const
 
 operator const sockaddr_in6 * () const
 
KInetSocketAddressoperator= (const KInetSocketAddress &other)
 
quint16 port () const
 
int scopeId () const
 
KInetSocketAddresssetFlowinfo (quint32 flowinfo)
 
KInetSocketAddresssetHost (const KIpAddress &addr)
 
KInetSocketAddresssetPort (quint16 port)
 
KInetSocketAddresssetScopeId (int scopeid)
 
- Public Member Functions inherited from KNetwork::KSocketAddress
 KSocketAddress ()
 
 KSocketAddress (const sockaddr *sa, quint16 len)
 
 KSocketAddress (const KSocketAddress &other)
 
virtual ~KSocketAddress ()
 
const sockaddr * address () const
 
sockaddr * address ()
 
KInetSocketAddressasInet ()
 
KInetSocketAddress asInet () const
 
KUnixSocketAddressasUnix ()
 
KUnixSocketAddress asUnix () const
 
int family () const
 
int ianaFamily () const
 
quint16 length () const
 
virtual QString nodeName () const
 
 operator const sockaddr * () const
 
KSocketAddressoperator= (const KSocketAddress &other)
 
bool operator== (const KSocketAddress &other) const
 
virtual QString serviceName () const
 
KSocketAddresssetAddress (const sockaddr *sa, quint16 len)
 
virtual KSocketAddresssetFamily (int family)
 
KSocketAddresssetLength (quint16 len)
 
virtual QString toString () const
 

Protected Member Functions

 KInetSocketAddress (KSocketAddressData *d)
 
- Protected Member Functions inherited from KNetwork::KSocketAddress
 KSocketAddress (KSocketAddressData *d)
 

Additional Inherited Members

- Static Public Member Functions inherited from KNetwork::KSocketAddress
static int fromIanaFamily (int iana)
 
static int ianaFamily (int af)
 
- Protected Attributes inherited from KNetwork::KSocketAddress
KSocketAddressData * d
 

Detailed Description

an Internet socket address

An Inet (IPv4 or IPv6) socket address

This is an IPv4 or IPv6 address of the Internet.

Author
Thiago Macieira thiag[email protected][email protected][email protected]e.org
Deprecated:
Use KSocketFactory or KLocalSocket instead

Definition at line 704 of file k3socketaddress.h.

Constructor & Destructor Documentation

KInetSocketAddress::KInetSocketAddress ( )

Public constructor.

Creates an empty object.

Definition at line 689 of file k3socketaddress.cpp.

KInetSocketAddress::KInetSocketAddress ( const sockaddr *  sa,
quint16  len 
)

Creates an object from raw data.

Note: if the socket address sa does not contain a valid Internet socket (IPv4 or IPv6), this object will be empty.

Parameters
sathe sockaddr structure
lenthe structure's length

Definition at line 694 of file k3socketaddress.cpp.

KInetSocketAddress::KInetSocketAddress ( const KIpAddress host,
quint16  port 
)

Creates an object from an IP address and port.

Parameters
hostthe IP address
portthe port number

Definition at line 703 of file k3socketaddress.cpp.

KInetSocketAddress::KInetSocketAddress ( const KInetSocketAddress other)

Copy constructor.

Data is not shared.

Parameters
otherthe other object

Definition at line 710 of file k3socketaddress.cpp.

KInetSocketAddress::KInetSocketAddress ( const KSocketAddress other)

Copy constructor.

If the other, generic socket address contains an Internet address, it will be copied. Otherwise, this object will be empty.

Parameters
otherthe other object

Definition at line 716 of file k3socketaddress.cpp.

KInetSocketAddress::~KInetSocketAddress ( )
virtual

Destroys this object.

Definition at line 731 of file k3socketaddress.cpp.

KInetSocketAddress::KInetSocketAddress ( KSocketAddressData *  d)
protected

extra constructor

Definition at line 725 of file k3socketaddress.cpp.

Member Function Documentation

quint32 KInetSocketAddress::flowinfo ( ) const

Returns the flowinfo information from the IPv6 socket address.

Returns
the flowinfo information or 0 if this object is empty or IPv4

Definition at line 858 of file k3socketaddress.cpp.

KIpAddress KInetSocketAddress::ipAddress ( ) const

Returns the IP address component.

Definition at line 763 of file k3socketaddress.cpp.

int KInetSocketAddress::ipVersion ( ) const

Returns the IP version of the address this object holds.

Returns
4 or 6, if IPv4 or IPv6, respectively; 0 if this object is empty

Definition at line 744 of file k3socketaddress.cpp.

KInetSocketAddress & KInetSocketAddress::makeIPv4 ( )

Converts this object to an IPv4 socket address.

It has no effect if the object is already an IPv4 socket address.

If this object is an IPv6 address, the port number is preserved. All other information is lost.

Returns
a reference to itself

Definition at line 846 of file k3socketaddress.cpp.

KInetSocketAddress & KInetSocketAddress::makeIPv6 ( )

Converts this object to an IPv6 socket address.

It has no effect if the object is already an IPv6 socket address.

If this object is an IPv4 address, the port number is preserved.

Returns
a reference to itself

Definition at line 852 of file k3socketaddress.cpp.

KNetwork::KInetSocketAddress::operator const sockaddr_in * ( ) const
inline

Cast operator to sockaddr_in.

Definition at line 768 of file k3socketaddress.h.

KNetwork::KInetSocketAddress::operator const sockaddr_in6 * ( ) const
inline

Cast operator to sockaddr_in6.

Definition at line 776 of file k3socketaddress.h.

KInetSocketAddress & KInetSocketAddress::operator= ( const KInetSocketAddress other)

Copy operator.

Copies the other object into this one.

Parameters
otherthe other object

Definition at line 737 of file k3socketaddress.cpp.

quint16 KInetSocketAddress::port ( ) const

Retrieves the port number stored in this object.

Returns
a port number in the range 0 to 65535, inclusive. An empty or invalid object will have a port number of 0.

Definition at line 803 of file k3socketaddress.cpp.

int KInetSocketAddress::scopeId ( ) const

Returns the scope id this IPv6 socket is bound to.

Returns
the scope id, or 0 if this is not an IPv6 object

Definition at line 878 of file k3socketaddress.cpp.

KInetSocketAddress & KInetSocketAddress::setFlowinfo ( quint32  flowinfo)

Sets the flowinfo information for an IPv6 socket address.

If this is not an IPv6 socket address, this function converts it to one. See makeIPv6.

Parameters
flowinfothe flowinfo to set
Returns
a reference to itself

Definition at line 871 of file k3socketaddress.cpp.

KInetSocketAddress & KInetSocketAddress::setHost ( const KIpAddress addr)

Sets the IP address to the given raw address.

This call will preserve port numbers across IP versions, but will lose IPv6 specific data if the address is set to IPv4.

Parameters
addrthe address to set to
Returns
a reference to itself

Definition at line 781 of file k3socketaddress.cpp.

KInetSocketAddress & KInetSocketAddress::setPort ( quint16  port)

Sets the port number.

If this object is empty, this function will default to creating an IPv4 address.

Parameters
portthe port number to set
Returns
a reference to itself

Definition at line 822 of file k3socketaddress.cpp.

KInetSocketAddress & KInetSocketAddress::setScopeId ( int  scopeid)

Sets the scope id for this IPv6 object.

If this is not an IPv6 socket address, this function converts it to one. See makeIPv6

Parameters
scopeidthe scopeid to set
Returns
a reference to itself

Definition at line 891 of file k3socketaddress.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Aug 8 2020 22:57:13 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.