Trinity API Reference #include <tdesocketaddress.h>
Protected Member Functions | |
| KInetSocketAddress (TDESocketAddressData *d) | |
 Protected Member Functions inherited from KNetwork::TDESocketAddress | |
| TDESocketAddress (TDESocketAddressData *d) | |
Friends | |
| class | TDESocketAddress |
Additional Inherited Members | |
| Static Public Member Functions inherited from KNetwork::TDESocketAddress | |
| static int | ianaFamily (int af) |
| static int | fromIanaFamily (int iana) |
| Protected Attributes inherited from KNetwork::TDESocketAddress | |
| TDESocketAddressData * | d |
Detailed Description
an Internet socket address
An Inet (IPv4 or IPv6) socket address
This is an IPv4 or IPv6 address of the Internet.
Definition at line 651 of file tdesocketaddress.h.
Constructor & Destructor Documentation
◆ KInetSocketAddress() [1/5]
| KInetSocketAddress::KInetSocketAddress | ( | ) |
◆ KInetSocketAddress() [2/5]
| KInetSocketAddress::KInetSocketAddress | ( | const sockaddr * | sa, |
| TQ_UINT16 | 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 713 of file tdesocketaddress.cpp.
◆ KInetSocketAddress() [3/5]
| KInetSocketAddress::KInetSocketAddress | ( | const KIpAddress & | host, |
| TQ_UINT16 | port | ||
| ) |
Creates an object from an IP address and port.
- Parameters
-
host the IP address port the port number
Definition at line 721 of file tdesocketaddress.cpp.
◆ KInetSocketAddress() [4/5]
| KInetSocketAddress::KInetSocketAddress | ( | const KInetSocketAddress & | other | ) |
Copy constructor.
Data is not shared.
- Parameters
-
other the other object
Definition at line 728 of file tdesocketaddress.cpp.
◆ KInetSocketAddress() [5/5]
| KInetSocketAddress::KInetSocketAddress | ( | const TDESocketAddress & | 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 734 of file tdesocketaddress.cpp.
◆ ~KInetSocketAddress()
|
virtual |
Destroys this object.
Definition at line 748 of file tdesocketaddress.cpp.
Member Function Documentation
◆ flowinfo()
| TQ_UINT32 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 892 of file tdesocketaddress.cpp.
◆ ipAddress()
| KIpAddress KInetSocketAddress::ipAddress | ( | ) | const |
Returns the IP address component.
Definition at line 784 of file tdesocketaddress.cpp.
◆ ipVersion()
| 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 761 of file tdesocketaddress.cpp.
◆ makeIPv4()
| 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 880 of file tdesocketaddress.cpp.
◆ makeIPv6()
| 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 886 of file tdesocketaddress.cpp.
◆ operator const sockaddr_in *()
|
inline |
Cast operator to sockaddr_in.
Definition at line 715 of file tdesocketaddress.h.
◆ operator const sockaddr_in6 *()
|
inline |
Cast operator to sockaddr_in6.
Definition at line 721 of file tdesocketaddress.h.
◆ operator=()
| KInetSocketAddress & KInetSocketAddress::operator= | ( | const KInetSocketAddress & | other | ) |
Copy operator.
Copies the other object into this one.
- Parameters
-
other the other object
Definition at line 754 of file tdesocketaddress.cpp.
◆ port()
| TQ_UINT16 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 829 of file tdesocketaddress.cpp.
◆ scopeId()
| 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 911 of file tdesocketaddress.cpp.
◆ setFlowinfo()
| KInetSocketAddress & KInetSocketAddress::setFlowinfo | ( | TQ_UINT32 | 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 904 of file tdesocketaddress.cpp.
◆ setHost()
| KInetSocketAddress & KInetSocketAddress::setHost | ( | const KIpAddress & | addr | ) |
Sets the IP address to the given raw address.
This call will preserve port numbers accross 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 806 of file tdesocketaddress.cpp.
◆ setPort()
| KInetSocketAddress & KInetSocketAddress::setPort | ( | TQ_UINT16 | 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 852 of file tdesocketaddress.cpp.
◆ setScopeId()
| 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 923 of file tdesocketaddress.cpp.
The documentation for this class was generated from the following files: