~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QHostAddress Class Reference</h1>

<p>The QHostAddress class provides an IP address. <a href="#details">More...</a></p>

<pre>#include <QHostAddress></pre><p>Part of the <a href="qtnetwork.html">QtNetwork</a> module.</p>

<ul>

<li><a href="qhostaddress-members.html">List of all members, including inherited members</a></li>

<li><a href="qhostaddress-qt3.html">Qt 3 support members</a></li>

</ul>

<h3>Public Types</h3>

<ul>

<li><div class="fn"/>enum <b><a href="qhostaddress.html#SpecialAddress-enum">SpecialAddress</a></b> { Null, LocalHost, LocalHostIPv6, Broadcast, Any, AnyIPv6 }</li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qhostaddress.html#QHostAddress">QHostAddress</a></b> ()</li>

<li><div class="fn"/><b><a href="qhostaddress.html#QHostAddress-2">QHostAddress</a></b> ( quint32 <i>ip4Addr</i> )</li>

<li><div class="fn"/><b><a href="qhostaddress.html#QHostAddress-3">QHostAddress</a></b> ( quint8 * <i>ip6Addr</i> )</li>

<li><div class="fn"/><b><a href="qhostaddress.html#QHostAddress-4">QHostAddress</a></b> ( const Q_IPV6ADDR & <i>ip6Addr</i> )</li>

<li><div class="fn"/><b><a href="qhostaddress.html#QHostAddress-5">QHostAddress</a></b> ( const QString & <i>address</i> )</li>

<li><div class="fn"/><b><a href="qhostaddress.html#QHostAddress-6">QHostAddress</a></b> ( const QHostAddress & <i>address</i> )</li>

<li><div class="fn"/><b><a href="qhostaddress.html#QHostAddress-7">QHostAddress</a></b> ( SpecialAddress <i>address</i> )</li>

<li><div class="fn"/><b><a href="qhostaddress.html#dtor.QHostAddress">~QHostAddress</a></b> ()</li>

<li><div class="fn"/>void <b><a href="qhostaddress.html#clear">clear</a></b> ()</li>

<li><div class="fn"/>bool <b><a href="qhostaddress.html#isNull">isNull</a></b> () const</li>

<li><div class="fn"/>QAbstractSocket::NetworkLayerProtocol <b><a href="qhostaddress.html#protocol">protocol</a></b> () const</li>

<li><div class="fn"/>void <b><a href="qhostaddress.html#setAddress">setAddress</a></b> ( quint32 <i>ip4Addr</i> )</li>

<li><div class="fn"/>void <b><a href="qhostaddress.html#setAddress-2">setAddress</a></b> ( quint8 * <i>ip6Addr</i> )</li>

<li><div class="fn"/>void <b><a href="qhostaddress.html#setAddress-3">setAddress</a></b> ( const Q_IPV6ADDR & <i>ip6Addr</i> )</li>

<li><div class="fn"/>bool <b><a href="qhostaddress.html#setAddress-4">setAddress</a></b> ( const QString & <i>address</i> )</li>

<li><div class="fn"/>quint32 <b><a href="qhostaddress.html#toIPv4Address">toIPv4Address</a></b> () const</li>

<li><div class="fn"/>Q_IPV6ADDR <b><a href="qhostaddress.html#toIPv6Address">toIPv6Address</a></b> () const</li>

<li><div class="fn"/>QString <b><a href="qhostaddress.html#toString">toString</a></b> () const</li>

<li><div class="fn"/>QHostAddress & <b><a href="qhostaddress.html#operator-eq">operator=</a></b> ( const QHostAddress & <i>address</i> )</li>

<li><div class="fn"/>bool <b><a href="qhostaddress.html#operator-eq-eq">operator==</a></b> ( const QHostAddress & <i>other</i> ) const</li>

<li><div class="fn"/>bool <b><a href="qhostaddress.html#operator-eq-eq-2">operator==</a></b> ( SpecialAddress <i>other</i> ) const</li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QHostAddress class provides an IP address.</p>

<p>This class holds an IPv4 or IPv6 address in a platform- and protocol-independent manner.</p>

<p>QHostAddress is normally used with the <a href="qtcpsocket.html">QTcpSocket</a>, <a href="qtcpserver.html">QTcpServer</a>, and <a href="qudpsocket.html">QUdpSocket</a> to connect to a host or to set up a server.</p>

<p>A host address is set with <a href="qhostaddress.html#setAddress">setAddress</a>(), checked for its type using <a href="qhostaddress-qt3.html#isIPv4Address">isIPv4Address</a>() or <a href="qhostaddress-qt3.html#isIPv6Address">isIPv6Address</a>(), and retrieved with <a href="qhostaddress.html#toIPv4Address">toIPv4Address</a>(), <a href="qhostaddress.html#toIPv6Address">toIPv6Address</a>(), or <a href="qhostaddress.html#toString">toString</a>().</p>

<p>The class also supports common predefined addresses: <a href="qhostaddress.html#SpecialAddress-enum">Null</a>, <a href="qhostaddress.html#SpecialAddress-enum">LocalHost</a>, <a href="qhostaddress.html#SpecialAddress-enum">LocalHostIPv6</a>, <a href="qhostaddress.html#SpecialAddress-enum">Broadcast</a>, and <a href="qhostaddress.html#SpecialAddress-enum">Any</a>.</p>

<p>See also <a href="qtcpsocket.html">QTcpSocket</a>, <a href="qtcpserver.html">QTcpServer</a>, and <a href="qudpsocket.html">QUdpSocket</a>.</p>

<hr />

<h2>Member Type Documentation</h2>

<h3 class="fn"><a name="SpecialAddress-enum"></a>enum QHostAddress::SpecialAddress</h3>

<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>

<tr><td valign="top"><tt>QHostAddress::Null</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The null address object. Equivalent to <a href="qhostaddress.html#QHostAddress">QHostAddress</a>().</td></tr>

<tr><td valign="top"><tt>QHostAddress::LocalHost</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">The IPv4 localhost address. Equivalent to <a href="qhostaddress.html">QHostAddress</a>("127.0.0.1").</td></tr>

<tr><td valign="top"><tt>QHostAddress::LocalHostIPv6</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">The IPv6 localhost address. Equivalent to <a href="qhostaddress.html">QHostAddress</a>("::1").</td></tr>

<tr><td valign="top"><tt>QHostAddress::Broadcast</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">The IPv4 broadcast address. Equivalent to <a href="qhostaddress.html">QHostAddress</a>("255.255.255.255").</td></tr>

<tr><td valign="top"><tt>QHostAddress::Any</tt></td><td align="center" valign="top"><tt>4</tt></td><td valign="top">The IPv4 any-address. Equivalent to <a href="qhostaddress.html">QHostAddress</a>("0.0.0.0").</td></tr>

<tr><td valign="top"><tt>QHostAddress::AnyIPv6</tt></td><td align="center" valign="top"><tt>5</tt></td><td valign="top">The IPv6 any-address. Equivalent to <a href="qhostaddress.html">QHostAddress</a>("::").</td></tr>

</table>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QHostAddress"></a>QHostAddress::QHostAddress ()</h3>

<p>Constructs a host address object with the IP address 0.0.0.0.</p>

<p>See also <a href="qhostaddress.html#clear">clear</a>().</p>

<h3 class="fn"><a name="QHostAddress-2"></a>QHostAddress::QHostAddress ( <a href="qtglobal.html#quint32-typedef">quint32</a> <i>ip4Addr</i> )</h3>

<p>Constructs a host address object with the IPv4 address <i>ip4Addr</i>.</p>

<h3 class="fn"><a name="QHostAddress-3"></a>QHostAddress::QHostAddress ( <a href="qtglobal.html#quint8-typedef">quint8</a> * <i>ip6Addr</i> )</h3>

<p>Constructs a host address object with the IPv6 address <i>ip6Addr</i>.</p>

<p><i>ip6Addr</i> must be a 16-byte array in network byte order (big endian).</p>

<h3 class="fn"><a name="QHostAddress-4"></a>QHostAddress::QHostAddress ( const Q_IPV6ADDR & <i>ip6Addr</i> )</h3>

<p>Constructs a host address object with the IPv6 address <i>ip6Addr</i>.</p>

<h3 class="fn"><a name="QHostAddress-5"></a>QHostAddress::QHostAddress ( const <a href="qstring.html">QString</a> & <i>address</i> )</h3>

<p>Constructs an IPv4 or IPv6 address based on the string <i>address</i> (e.g., "127.0.0.1").</p>

<p>See also <a href="qhostaddress.html#setAddress">setAddress</a>().</p>

<h3 class="fn"><a name="QHostAddress-6"></a>QHostAddress::QHostAddress ( const QHostAddress & <i>address</i> )</h3>

<p>Constructs a copy of the given <i>address</i>.</p>

<h3 class="fn"><a name="QHostAddress-7"></a>QHostAddress::QHostAddress ( <a href="qhostaddress.html#SpecialAddress-enum">SpecialAddress</a> <i>address</i> )</h3>

<p>Constructs a <a href="qhostaddress.html">QHostAddress</a> object for <i>address</i>.</p>

<h3 class="fn"><a name="dtor.QHostAddress"></a>QHostAddress::~QHostAddress ()</h3>

<p>Destroys the host address object.</p>

<h3 class="fn"><a name="clear"></a>void QHostAddress::clear ()</h3>

100

<p>Sets the host address to 0.0.0.0.</p>

101

<h3 class="fn"><a name="isNull"></a>bool QHostAddress::isNull () const</h3>

102

<p>Returns true if this host address is null (INADDR_ANY or in6addr_any). The default constructor creates a null address, and that address is not valid for any host or interface.</p>

103

<h3 class="fn"><a name="protocol"></a><a href="qabstractsocket.html#NetworkLayerProtocol-enum">QAbstractSocket::NetworkLayerProtocol</a> QHostAddress::protocol () const</h3>

104

<p>Returns the network layer protocol of the host address.</p>

105

<h3 class="fn"><a name="setAddress"></a>void QHostAddress::setAddress ( <a href="qtglobal.html#quint32-typedef">quint32</a> <i>ip4Addr</i> )</h3>

106

<p>Set the IPv4 address specified by <i>ip4Addr</i>.</p>

107

<h3 class="fn"><a name="setAddress-2"></a>void QHostAddress::setAddress ( <a href="qtglobal.html#quint8-typedef">quint8</a> * <i>ip6Addr</i> )</h3>

108

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

109

<p>Set the IPv6 address specified by <i>ip6Addr</i>.</p>

110

<p><i>ip6Addr</i> must be an array of 16 bytes in network byte order (high-order byte first).</p>

111

<h3 class="fn"><a name="setAddress-3"></a>void QHostAddress::setAddress ( const Q_IPV6ADDR & <i>ip6Addr</i> )</h3>

112

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

113

<p>Set the IPv6 address specified by <i>ip6Addr</i>.</p>

114

<h3 class="fn"><a name="setAddress-4"></a>bool QHostAddress::setAddress ( const <a href="qstring.html">QString</a> & <i>address</i> )</h3>

115

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

116

<p>Sets the IPv4 or IPv6 address specified by the string representation specified by <i>address</i> (e.g. "127.0.0.1"). Returns true and sets the address if the address was successfully parsed; otherwise returns false.</p>

117

<h3 class="fn"><a name="toIPv4Address"></a><a href="qtglobal.html#quint32-typedef">quint32</a> QHostAddress::toIPv4Address () const</h3>

118

<p>Returns the IPv4 address as a number.</p>

119

<p>For example, if the address is 127.0.0.1, the returned value is 2130706433 (i.e. 0x7f000001).</p>

120

<p>This value is only valid if <a href="qhostaddress-qt3.html#isIp4Addr">isIp4Addr</a>() returns true.</p>

121

<p>See also <a href="qhostaddress.html#toString">toString</a>().</p>

122

<h3 class="fn"><a name="toIPv6Address"></a>Q_IPV6ADDR QHostAddress::toIPv6Address () const</h3>

123

<p>Returns the IPv6 address as a Q_IPV6ADDR structure. The structure consists of 16 unsigned characters.</p>

124

<pre>  Q_IPV6ADDR addr = hostAddr.ip6Addr();

125

// addr contains 16 unsigned characters

126

127

for (int i = 0; i < 16; ++i) {

128

// process addr[i]

129

}</pre>

130

<p>This value is only valid if <a href="qhostaddress-qt3.html#isIPv6Address">isIPv6Address</a>() returns true.</p>

131

<p>See also <a href="qhostaddress.html#toString">toString</a>().</p>

132

<h3 class="fn"><a name="toString"></a><a href="qstring.html">QString</a> QHostAddress::toString () const</h3>

133

<p>Returns the address as a string.</p>

134

<p>For example, if the address is the IPv4 address 127.0.0.1, the returned string is "127.0.0.1".</p>

135

<p>See also <a href="qhostaddress.html#toIPv4Address">toIPv4Address</a>().</p>

136

<h3 class="fn"><a name="operator-eq"></a>QHostAddress & QHostAddress::operator= ( const QHostAddress & <i>address</i> )</h3>

137

<p>Assigns another host <i>address</i> to this object, and returns a reference to this object.</p>

138

<h3 class="fn"><a name="operator-eq-eq"></a>bool QHostAddress::operator== ( const QHostAddress & <i>other</i> ) const</h3>

139

<p>Returns true if this host address is the same as the <i>other</i> address given; otherwise returns false.</p>

140

<h3 class="fn"><a name="operator-eq-eq-2"></a>bool QHostAddress::operator== ( <a href="qhostaddress.html#SpecialAddress-enum">SpecialAddress</a> <i>other</i> ) const</h3>

141

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

142

<p>Returns true if this host address is the same as the <i>other</i> address given; otherwise returns false.</p>

143

144

145

146

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

147

148

</tr></table></div></address></body>

149

</html>

Older »