• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KNetwork::KInetSocketAddress

KNetwork::KInetSocketAddress Class Reference

#include <k3socketaddress.h>

Inheritance diagram for KNetwork::KInetSocketAddress:

Inheritance graph
[legend]

List of all members.


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 <thiago@kde.org>

Definition at line 640 of file k3socketaddress.h.


Public Member Functions

quint32 flowinfo () const
KIpAddress ipAddress () const
int ipVersion () const
 KInetSocketAddress (const KSocketAddress &other)
 KInetSocketAddress (const KInetSocketAddress &other)
 KInetSocketAddress (const KIpAddress &host, quint16 port)
 KInetSocketAddress (const sockaddr *sa, quint16 len)
 KInetSocketAddress ()
KInetSocketAddress & makeIPv4 ()
KInetSocketAddress & makeIPv6 ()
 operator const sockaddr_in * () const
 operator const sockaddr_in6 * () const
KInetSocketAddress & operator= (const KInetSocketAddress &other)
quint16 port () const
int scopeId () const
KInetSocketAddress & setFlowinfo (quint32 flowinfo)
KInetSocketAddress & setHost (const KIpAddress &addr)
KInetSocketAddress & setPort (quint16 port)
KInetSocketAddress & setScopeId (int scopeid)
virtual ~KInetSocketAddress ()

Protected Member Functions

 KInetSocketAddress (KSocketAddressData *d)

Constructor & Destructor Documentation

KInetSocketAddress::KInetSocketAddress (  ) 

Public constructor.

Creates an empty object.

Definition at line 683 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:
sa the sockaddr structure
len the structure's length

Definition at line 688 of file k3socketaddress.cpp.

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

Creates an object from an IP address and port.

Parameters:
host the IP address
port the port number

Definition at line 696 of file k3socketaddress.cpp.

KInetSocketAddress::KInetSocketAddress ( const KInetSocketAddress &  other  ) 

Copy constructor.

Data is not shared.

Parameters:
other the other object

Definition at line 703 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:
other the other object

Definition at line 709 of file k3socketaddress.cpp.

KInetSocketAddress::~KInetSocketAddress (  )  [virtual]

Destroys this object.

Definition at line 723 of file k3socketaddress.cpp.

KInetSocketAddress::KInetSocketAddress ( KSocketAddressData *  d  )  [protected]

Definition at line 717 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 851 of file k3socketaddress.cpp.

KIpAddress KInetSocketAddress::ipAddress (  )  const

Returns the IP address component.

Definition at line 755 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 736 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 839 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 845 of file k3socketaddress.cpp.

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

Cast operator to sockaddr_in.

Definition at line 704 of file k3socketaddress.h.

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

Cast operator to sockaddr_in6.

Definition at line 710 of file k3socketaddress.h.

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

Copy operator.

Copies the other object into this one.

Parameters:
other the other object

Definition at line 729 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 796 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 869 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:
flowinfo the flowinfo to set
Returns:
a reference to itself

Definition at line 862 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:
addr the address to set to
Returns:
a reference to itself

Definition at line 773 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:
port the port number to set
Returns:
a reference to itself

Definition at line 815 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:
scopeid the scopeid to set
Returns:
a reference to itself

Definition at line 880 of file k3socketaddress.cpp.


The documentation for this class was generated from the following files:
  • k3socketaddress.h
  • k3socketaddress.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal