<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qabstractsocket.cpp -->
<title>Qt 4.8: QAbstractSocket Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtnetwork.html">QtNetwork</a></li>
<li>QAbstractSocket</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#protected-slots">Protected Slots</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAbstractSocket Class Reference</h1>
<!-- $$$QAbstractSocket-brief -->
<p>The QAbstractSocket class provides the base functionality common to all socket types. <a href="#details">More...</a></p>
<!-- @@@QAbstractSocket -->
<pre class="cpp"> <span class="preprocessor">#include <QAbstractSocket></span></pre><p><b>Inherits: </b><a href="qiodevice.html">QIODevice</a>.</p>
<p><b>Inherited by: </b><a href="qtcpsocket.html">QTcpSocket</a> and <a href="qudpsocket.html">QUdpSocket</a>.</p>
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qabstractsocket-members.html">List of all members, including inherited members</a></li>
<li><a href="qabstractsocket-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#NetworkLayerProtocol-enum">NetworkLayerProtocol</a></b> { IPv4Protocol, IPv6Protocol, UnknownNetworkLayerProtocol }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#SocketError-enum">SocketError</a></b> { ConnectionRefusedError, RemoteHostClosedError, HostNotFoundError, SocketAccessError, ..., UnknownSocketError }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#SocketOption-enum">SocketOption</a></b> { LowDelayOption, KeepAliveOption, MulticastTtlOption, MulticastLoopbackOption }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#SocketState-enum">SocketState</a></b> { UnconnectedState, HostLookupState, ConnectingState, ConnectedState, ..., ListeningState }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#SocketType-enum">SocketType</a></b> { TcpSocket, UdpSocket, UnknownSocketType }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#QAbstractSocket">QAbstractSocket</a></b> ( SocketType <i>socketType</i>, QObject * <i>parent</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#dtor.QAbstractSocket">~QAbstractSocket</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#abort">abort</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#connectToHost">connectToHost</a></b> ( const QString & <i>hostName</i>, quint16 <i>port</i>, OpenMode <i>openMode</i> = ReadWrite )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#connectToHost-2">connectToHost</a></b> ( const QHostAddress & <i>address</i>, quint16 <i>port</i>, OpenMode <i>openMode</i> = ReadWrite )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#disconnectFromHost">disconnectFromHost</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SocketError </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#error">error</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#flush">flush</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHostAddress </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#localAddress">localAddress</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> quint16 </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#localPort">localPort</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHostAddress </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#peerAddress">peerAddress</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#peerName">peerName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> quint16 </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#peerPort">peerPort</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QNetworkProxy </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#proxy">proxy</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#readBufferSize">readBufferSize</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setProxy">setProxy</a></b> ( const QNetworkProxy & <i>networkProxy</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setReadBufferSize">setReadBufferSize</a></b> ( qint64 <i>size</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setSocketDescriptor">setSocketDescriptor</a></b> ( int <i>socketDescriptor</i>, SocketState <i>socketState</i> = ConnectedState, OpenMode <i>openMode</i> = ReadWrite )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setSocketOption">setSocketOption</a></b> ( QAbstractSocket::SocketOption <i>option</i>, const QVariant & <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#socketDescriptor">socketDescriptor</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#socketOption">socketOption</a></b> ( QAbstractSocket::SocketOption <i>option</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SocketType </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#socketType">socketType</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SocketState </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#state">state</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#waitForConnected">waitForConnected</a></b> ( int <i>msecs</i> = 30000 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#waitForDisconnected">waitForDisconnected</a></b> ( int <i>msecs</i> = 30000 )</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#atEnd">atEnd</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#bytesAvailable">bytesAvailable</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#bytesToWrite">bytesToWrite</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#canReadLine">canReadLine</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#close">close</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#isSequential">isSequential</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#waitForBytesWritten">waitForBytesWritten</a></b> ( int <i>msecs</i> = 30000 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#waitForReadyRead">waitForReadyRead</a></b> ( int <i>msecs</i> = 30000 )</td></tr>
</table>
<ul>
<li class="fn">33 public functions inherited from <a href="qiodevice.html#public-functions">QIODevice</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#connected">connected</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#disconnected">disconnected</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#error-2">error</a></b> ( QAbstractSocket::SocketError <i>socketError</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#hostFound">hostFound</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#proxyAuthenticationRequired">proxyAuthenticationRequired</a></b> ( const QNetworkProxy & <i>proxy</i>, QAuthenticator * <i>authenticator</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#stateChanged">stateChanged</a></b> ( QAbstractSocket::SocketState <i>socketState</i> )</td></tr>
</table>
<ul>
<li class="fn">4 signals inherited from <a href="qiodevice.html#signals">QIODevice</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setLocalAddress">setLocalAddress</a></b> ( const QHostAddress & <i>address</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setLocalPort">setLocalPort</a></b> ( quint16 <i>port</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setPeerAddress">setPeerAddress</a></b> ( const QHostAddress & <i>address</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setPeerName">setPeerName</a></b> ( const QString & <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setPeerPort">setPeerPort</a></b> ( quint16 <i>port</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setSocketError">setSocketError</a></b> ( SocketError <i>socketError</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#setSocketState">setSocketState</a></b> ( SocketState <i>state</i> )</td></tr>
</table>
<a name="reimplemented-protected-functions"></a>
<h2>Reimplemented Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#readData">readData</a></b> ( char * <i>data</i>, qint64 <i>maxSize</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#readLineData">readLineData</a></b> ( char * <i>data</i>, qint64 <i>maxlen</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#writeData">writeData</a></b> ( const char * <i>data</i>, qint64 <i>size</i> )</td></tr>
</table>
<ul>
<li class="fn">5 protected functions inherited from <a href="qiodevice.html#protected-functions">QIODevice</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="protected-slots"></a>
<h2>Protected Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#connectToHostImplementation">connectToHostImplementation</a></b> ( const QString & <i>hostName</i>, quint16 <i>port</i>, OpenMode <i>openMode</i> = ReadWrite )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractsocket.html#disconnectFromHostImplementation">disconnectFromHostImplementation</a></b> ()</td></tr>
</table>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAbstractSocket-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAbstractSocket class provides the base functionality common to all socket types.</p>
<p>QAbstractSocket is the base class for <a href="qtcpsocket.html">QTcpSocket</a> and <a href="qudpsocket.html">QUdpSocket</a> and contains all common functionality of these two classes. If you need a socket, you have two options:</p>
<ul>
<li>Instantiate <a href="qtcpsocket.html">QTcpSocket</a> or <a href="qudpsocket.html">QUdpSocket</a>.</li>
<li>Create a native socket descriptor, instantiate QAbstractSocket, and call <a href="qabstractsocket.html#setSocketDescriptor">setSocketDescriptor</a>() to wrap the native socket.</li>
</ul>
<p>TCP (Transmission Control Protocol) is a reliable, stream-oriented, connection-oriented transport protocol. UDP (User Datagram Protocol) is an unreliable, datagram-oriented, connectionless protocol. In practice, this means that TCP is better suited for continuous transmission of data, whereas the more lightweight UDP can be used when reliability isn't important.</p>
<p>QAbstractSocket's API unifies most of the differences between the two protocols. For example, although UDP is connectionless, <a href="qabstractsocket.html#connectToHost">connectToHost</a>() establishes a virtual connection for UDP sockets, enabling you to use QAbstractSocket in more or less the same way regardless of the underlying protocol. Internally, QAbstractSocket remembers the address and port passed to <a href="qabstractsocket.html#connectToHost">connectToHost</a>(), and functions like <a href="qiodevice.html#read">read</a>() and <a href="qiodevice.html#write">write</a>() use these values.</p>
<p>At any time, QAbstractSocket has a state (returned by <a href="qabstractsocket.html#state">state</a>()). The initial state is <a href="qabstractsocket.html#SocketState-enum">UnconnectedState</a>. After calling <a href="qabstractsocket.html#connectToHost">connectToHost</a>(), the socket first enters <a href="qabstractsocket.html#SocketState-enum">HostLookupState</a>. If the host is found, QAbstractSocket enters <a href="qabstractsocket.html#SocketState-enum">ConnectingState</a> and emits the <a href="qabstractsocket.html#hostFound">hostFound</a>() signal. When the connection has been established, it enters <a href="qabstractsocket.html#SocketState-enum">ConnectedState</a> and emits <a href="qabstractsocket.html#connected">connected</a>(). If an error occurs at any stage, <a href="qabstractsocket.html#error">error</a>() is emitted. Whenever the state changes, <a href="qabstractsocket.html#stateChanged">stateChanged</a>() is emitted. For convenience, <a href="qabstractsocket.html#isValid">isValid</a>() returns true if the socket is ready for reading and writing, but note that the socket's state must be <a href="qabstractsocket.html#SocketState-enum">ConnectedState</a> before reading and writing can occur.</p>
<p>Read or write data by calling <a href="qiodevice.html#read">read</a>() or <a href="qiodevice.html#write">write</a>(), or use the convenience functions <a href="qiodevice.html#readLine">readLine</a>() and <a href="qiodevice.html#readAll">readAll</a>(). QAbstractSocket also inherits <a href="qiodevice.html#getChar">getChar</a>(), <a href="qiodevice.html#putChar">putChar</a>(), and <a href="qiodevice.html#ungetChar">ungetChar</a>() from <a href="qiodevice.html">QIODevice</a>, which work on single bytes. The <a href="qiodevice.html#bytesWritten">bytesWritten</a>() signal is emitted when data has been written to the socket (i.e., when the client has read the data). Note that Qt does not limit the write buffer size. You can monitor its size by listening to this signal.</p>
<p>The <a href="qiodevice.html#readyRead">readyRead</a>() signal is emitted every time a new chunk of data has arrived. <a href="qabstractsocket.html#bytesAvailable">bytesAvailable</a>() then returns the number of bytes that are available for reading. Typically, you would connect the <a href="qiodevice.html#readyRead">readyRead</a>() signal to a slot and read all available data there. If you don't read all the data at once, the remaining data will still be available later, and any new incoming data will be appended to QAbstractSocket's internal read buffer. To limit the size of the read buffer, call <a href="qabstractsocket.html#setReadBufferSize">setReadBufferSize</a>().</p>
<p>To close the socket, call <a href="qabstractsocket.html#disconnectFromHost">disconnectFromHost</a>(). QAbstractSocket enters <a href="qabstractsocket.html#SocketState-enum">QAbstractSocket::ClosingState</a>. After all pending data has been written to the socket, QAbstractSocket actually closes the socket, enters QAbstractSocket::ClosedState, and emits <a href="qabstractsocket.html#disconnected">disconnected</a>(). If you want to abort a connection immediately, discarding all pending data, call <a href="qabstractsocket.html#abort">abort</a>() instead. If the remote host closes the connection, QAbstractSocket will emit error(<a href="qabstractsocket.html#SocketError-enum">QAbstractSocket::RemoteHostClosedError</a>), during which the socket state will still be <a href="qabstractsocket.html#SocketState-enum">ConnectedState</a>, and then the <a href="qabstractsocket.html#disconnected">disconnected</a>() signal will be emitted.</p>
<p>The port and address of the connected peer is fetched by calling <a href="qabstractsocket.html#peerPort">peerPort</a>() and <a href="qabstractsocket.html#peerAddress">peerAddress</a>(). <a href="qabstractsocket.html#peerName">peerName</a>() returns the host name of the peer, as passed to <a href="qabstractsocket.html#connectToHost">connectToHost</a>(). <a href="qabstractsocket.html#localPort">localPort</a>() and <a href="qabstractsocket.html#localAddress">localAddress</a>() return the port and address of the local socket.</p>
<p>QAbstractSocket provides a set of functions that suspend the calling thread until certain signals are emitted. These functions can be used to implement blocking sockets:</p>
<ul>
<li><a href="qabstractsocket.html#waitForConnected">waitForConnected</a>() blocks until a connection has been established.</li>
<li><a href="qabstractsocket.html#waitForReadyRead">waitForReadyRead</a>() blocks until new data is available for reading.</li>
<li><a href="qabstractsocket.html#waitForBytesWritten">waitForBytesWritten</a>() blocks until one payload of data has been written to the socket.</li>
<li><a href="qabstractsocket.html#waitForDisconnected">waitForDisconnected</a>() blocks until the connection has closed.</li>
</ul>
<p>We show an example:</p>
<pre class="cpp"> <span class="type">int</span> numRead <span class="operator">=</span> <span class="number">0</span><span class="operator">,</span> numReadTotal <span class="operator">=</span> <span class="number">0</span>;
<span class="type">char</span> buffer<span class="operator">[</span><span class="number">50</span><span class="operator">]</span>;
forever {
numRead <span class="operator">=</span> socket<span class="operator">.</span>read(buffer<span class="operator">,</span> <span class="number">50</span>);
<span class="comment">// do whatever with array</span>
numReadTotal <span class="operator">+</span><span class="operator">=</span> numRead;
<span class="keyword">if</span> (numRead <span class="operator">=</span><span class="operator">=</span> <span class="number">0</span> <span class="operator">&</span><span class="operator">&</span> <span class="operator">!</span>socket<span class="operator">.</span>waitForReadyRead())
<span class="keyword">break</span>;
}</pre>
<p>If <a href="qiodevice.html#waitForReadyRead">waitForReadyRead()</a> returns false, the connection has been closed or an error has occurred.</p>
<p>Programming with a blocking socket is radically different from programming with a non-blocking socket. A blocking socket doesn't require an event loop and typically leads to simpler code. However, in a GUI application, blocking sockets should only be used in non-GUI threads, to avoid freezing the user interface. See the <a href="network-fortuneclient.html">network/fortuneclient</a> and <a href="network-blockingfortuneclient.html">network/blockingfortuneclient</a> examples for an overview of both approaches.</p>
<p><b>Note:</b> We discourage the use of the blocking functions together with signals. One of the two possibilities should be used.</p>
<p>QAbstractSocket can be used with <a href="qtextstream.html">QTextStream</a> and <a href="qdatastream.html">QDataStream</a>'s stream operators (operator<<() and operator>>()). There is one issue to be aware of, though: You must make sure that enough data is available before attempting to read it using operator>>().</p>
</div>
<p><b>See also </b><a href="qftp.html">QFtp</a>, <a href="qnetworkaccessmanager.html">QNetworkAccessManager</a>, and <a href="qtcpserver.html">QTcpServer</a>.</p>
<!-- @@@QAbstractSocket -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$NetworkLayerProtocol$$$IPv4Protocol$$$IPv6Protocol$$$UnknownNetworkLayerProtocol -->
<h3 class="fn"><a name="NetworkLayerProtocol-enum"></a>enum QAbstractSocket::<span class="name">NetworkLayerProtocol</span></h3>
<p>This enum describes the network layer protocol values used in Qt.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::IPv4Protocol</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">IPv4</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::IPv6Protocol</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">IPv6</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::UnknownNetworkLayerProtocol</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">Other than IPv4 and IPv6</td></tr>
</table>
<p><b>See also </b><a href="qhostaddress.html#protocol">QHostAddress::protocol</a>().</p>
<!-- @@@NetworkLayerProtocol -->
<!-- $$$SocketError$$$ConnectionRefusedError$$$RemoteHostClosedError$$$HostNotFoundError$$$SocketAccessError$$$SocketResourceError$$$SocketTimeoutError$$$DatagramTooLargeError$$$NetworkError$$$AddressInUseError$$$SocketAddressNotAvailableError$$$UnsupportedSocketOperationError$$$UnfinishedSocketOperationError$$$ProxyAuthenticationRequiredError$$$SslHandshakeFailedError$$$ProxyConnectionRefusedError$$$ProxyConnectionClosedError$$$ProxyConnectionTimeoutError$$$ProxyNotFoundError$$$ProxyProtocolError$$$UnknownSocketError -->
<h3 class="fn"><a name="SocketError-enum"></a>enum QAbstractSocket::<span class="name">SocketError</span></h3>
<p>This enum describes the socket errors that can occur.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ConnectionRefusedError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The connection was refused by the peer (or timed out).</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::RemoteHostClosedError</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The remote host closed the connection. Note that the client socket (i.e., this socket) will be closed after the remote close notification has been sent.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::HostNotFoundError</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The host address was not found.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::SocketAccessError</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The socket operation failed because the application lacked the required privileges.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::SocketResourceError</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The local system ran out of resources (e.g., too many sockets).</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::SocketTimeoutError</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The socket operation timed out.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::DatagramTooLargeError</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">The datagram was larger than the operating system's limit (which can be as low as 8192 bytes).</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::NetworkError</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">An error occurred with the network (e.g., the network cable was accidentally plugged out).</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::AddressInUseError</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">The address specified to <a href="qudpsocket.html#bind">QUdpSocket::bind</a>() is already in use and was set to be exclusive.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::SocketAddressNotAvailableError</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">The address specified to <a href="qudpsocket.html#bind">QUdpSocket::bind</a>() does not belong to the host.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::UnsupportedSocketOperationError</tt></td><td class="topAlign"><tt>10</tt></td><td class="topAlign">The requested socket operation is not supported by the local operating system (e.g., lack of IPv6 support).</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ProxyAuthenticationRequiredError</tt></td><td class="topAlign"><tt>12</tt></td><td class="topAlign">The socket is using a proxy, and the proxy requires authentication.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::SslHandshakeFailedError</tt></td><td class="topAlign"><tt>13</tt></td><td class="topAlign">The SSL/TLS handshake failed, so the connection was closed (only used in <a href="qsslsocket.html">QSslSocket</a>) (This value was introduced in 4.4.)</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::UnfinishedSocketOperationError</tt></td><td class="topAlign"><tt>11</tt></td><td class="topAlign">Used by QAbstractSocketEngine only, The last operation attempted has not finished yet (still in progress in the background). (This value was introduced in 4.4.)</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ProxyConnectionRefusedError</tt></td><td class="topAlign"><tt>14</tt></td><td class="topAlign">Could not contact the proxy server because the connection to that server was denied (This value was introduced in 4.5.)</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ProxyConnectionClosedError</tt></td><td class="topAlign"><tt>15</tt></td><td class="topAlign">The connection to the proxy server was closed unexpectedly (before the connection to the final peer was established) (This value was introduced in 4.5.)</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ProxyConnectionTimeoutError</tt></td><td class="topAlign"><tt>16</tt></td><td class="topAlign">The connection to the proxy server timed out or the proxy server stopped responding in the authentication phase. (This value was introduced in 4.5.)</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ProxyNotFoundError</tt></td><td class="topAlign"><tt>17</tt></td><td class="topAlign">The proxy address set with <a href="qabstractsocket.html#setProxy">setProxy</a>() (or the application proxy) was not found. (This value was introduced in 4.5.)</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ProxyProtocolError</tt></td><td class="topAlign"><tt>18</tt></td><td class="topAlign">The connection negotiation with the proxy server because the response from the proxy server could not be understood. (This value was introduced in 4.5.)</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::UnknownSocketError</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">An unidentified error occurred.</td></tr>
</table>
<p><b>See also </b><a href="qabstractsocket.html#error">QAbstractSocket::error</a>().</p>
<!-- @@@SocketError -->
<!-- $$$SocketOption$$$LowDelayOption$$$KeepAliveOption$$$MulticastTtlOption$$$MulticastLoopbackOption -->
<h3 class="fn"><a name="SocketOption-enum"></a>enum QAbstractSocket::<span class="name">SocketOption</span></h3>
<p>This enum represents the options that can be set on a socket. If desired, they can be set after having received the <a href="qabstractsocket.html#connected">connected</a>() signal from the socket or after having received a new socket from a <a href="qtcpserver.html">QTcpServer</a>.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::LowDelayOption</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Try to optimize the socket for low latency. For a <a href="qtcpsocket.html">QTcpSocket</a> this would set the TCP_NODELAY option and disable Nagle's algorithm. Set this to 1 to enable.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::KeepAliveOption</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Set this to 1 to enable the SO_KEEPALIVE socket option</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::MulticastTtlOption</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Set this to an integer value to set IP_MULTICAST_TTL (TTL for multicast datagrams) socket option.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::MulticastLoopbackOption</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">Set this to 1 to enable the IP_MULTICAST_LOOP (multicast loopback) socket option.</td></tr>
</table>
<p>This enum was introduced or modified in Qt 4.6.</p>
<p><b>See also </b><a href="qabstractsocket.html#setSocketOption">QAbstractSocket::setSocketOption</a>() and <a href="qabstractsocket.html#socketOption">QAbstractSocket::socketOption</a>().</p>
<!-- @@@SocketOption -->
<!-- $$$SocketState$$$UnconnectedState$$$HostLookupState$$$ConnectingState$$$ConnectedState$$$BoundState$$$ListeningState$$$ClosingState$$$Idle$$$HostLookup$$$Connecting$$$Connected$$$Closing$$$Connection -->
<h3 class="fn"><a name="SocketState-enum"></a>enum QAbstractSocket::<span class="name">SocketState</span></h3>
<p>This enum describes the different states in which a socket can be.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::UnconnectedState</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The socket is not connected.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::HostLookupState</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The socket is performing a host name lookup.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ConnectingState</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The socket has started establishing a connection.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ConnectedState</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">A connection is established.</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::BoundState</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The socket is bound to an address and port (for servers).</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ClosingState</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">The socket is about to close (data may still be waiting to be written).</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::ListeningState</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">For internal use only.</td></tr>
</table>
<p><b>See also </b><a href="qabstractsocket.html#state">QAbstractSocket::state</a>().</p>
<!-- @@@SocketState -->
<!-- $$$SocketType$$$TcpSocket$$$UdpSocket$$$UnknownSocketType -->
<h3 class="fn"><a name="SocketType-enum"></a>enum QAbstractSocket::<span class="name">SocketType</span></h3>
<p>This enum describes the transport layer protocol.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::TcpSocket</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">TCP</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::UdpSocket</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">UDP</td></tr>
<tr><td class="topAlign"><tt>QAbstractSocket::UnknownSocketType</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">Other than TCP and UDP</td></tr>
</table>
<p><b>See also </b><a href="qabstractsocket.html#socketType">QAbstractSocket::socketType</a>().</p>
<!-- @@@SocketType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAbstractSocket[overload1]$$$QAbstractSocketSocketTypeQObject* -->
<h3 class="fn"><a name="QAbstractSocket"></a>QAbstractSocket::<span class="name">QAbstractSocket</span> ( <span class="type"><a href="qabstractsocket.html#SocketType-enum">SocketType</a></span> <i>socketType</i>, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> )</h3>
<p>Creates a new abstract socket of type <i>socketType</i>. The <i>parent</i> argument is passed to <a href="qobject.html">QObject</a>'s constructor.</p>
<p><b>See also </b><a href="qabstractsocket.html#socketType">socketType</a>(), <a href="qtcpsocket.html">QTcpSocket</a>, and <a href="qudpsocket.html">QUdpSocket</a>.</p>
<!-- @@@QAbstractSocket -->
<!-- $$$~QAbstractSocket[overload1]$$$~QAbstractSocket -->
<h3 class="fn"><a name="dtor.QAbstractSocket"></a>QAbstractSocket::<span class="name">~QAbstractSocket</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the socket.</p>
<!-- @@@~QAbstractSocket -->
<!-- $$$abort[overload1]$$$abort -->
<h3 class="fn"><a name="abort"></a><span class="type">void</span> QAbstractSocket::<span class="name">abort</span> ()</h3>
<p>Aborts the current connection and resets the socket. Unlike <a href="qabstractsocket.html#disconnectFromHost">disconnectFromHost</a>(), this function immediately closes the socket, discarding any pending data in the write buffer.</p>
<p><b>See also </b><a href="qabstractsocket.html#disconnectFromHost">disconnectFromHost</a>() and <a href="qabstractsocket.html#close">close</a>().</p>
<!-- @@@abort -->
<!-- $$$atEnd[overload1]$$$atEnd -->
<h3 class="fn"><a name="atEnd"></a><span class="type">bool</span> QAbstractSocket::<span class="name">atEnd</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#atEnd">QIODevice::atEnd</a>().</p>
<p>Returns true if no more data is currently available for reading; otherwise returns false.</p>
<p>This function is most commonly used when reading data from the socket in a loop. For example:</p>
<pre class="cpp"> <span class="comment">// This slot is connected to QAbstractSocket::readyRead()</span>
<span class="type">void</span> SocketClass<span class="operator">::</span>readyReadSlot()
{
<span class="keyword">while</span> (<span class="operator">!</span>socket<span class="operator">.</span>atEnd()) {
<span class="type"><a href="qbytearray.html">QByteArray</a></span> data <span class="operator">=</span> socket<span class="operator">.</span>read(<span class="number">100</span>);
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
}
}</pre>
<p><b>See also </b><a href="qabstractsocket.html#bytesAvailable">bytesAvailable</a>() and <a href="qiodevice.html#readyRead">readyRead</a>().</p>
<!-- @@@atEnd -->
<!-- $$$bytesAvailable[overload1]$$$bytesAvailable -->
<h3 class="fn"><a name="bytesAvailable"></a><span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> QAbstractSocket::<span class="name">bytesAvailable</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#bytesAvailable">QIODevice::bytesAvailable</a>().</p>
<p>Returns the number of incoming bytes that are waiting to be read.</p>
<p><b>See also </b><a href="qabstractsocket.html#bytesToWrite">bytesToWrite</a>() and <a href="qiodevice.html#read">read</a>().</p>
<!-- @@@bytesAvailable -->
<!-- $$$bytesToWrite[overload1]$$$bytesToWrite -->
<h3 class="fn"><a name="bytesToWrite"></a><span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> QAbstractSocket::<span class="name">bytesToWrite</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#bytesToWrite">QIODevice::bytesToWrite</a>().</p>
<p>Returns the number of bytes that are waiting to be written. The bytes are written when control goes back to the event loop or when <a href="qabstractsocket.html#flush">flush</a>() is called.</p>
<p><b>See also </b><a href="qabstractsocket.html#bytesAvailable">bytesAvailable</a>() and <a href="qabstractsocket.html#flush">flush</a>().</p>
<!-- @@@bytesToWrite -->
<!-- $$$canReadLine[overload1]$$$canReadLine -->
<h3 class="fn"><a name="canReadLine"></a><span class="type">bool</span> QAbstractSocket::<span class="name">canReadLine</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#canReadLine">QIODevice::canReadLine</a>().</p>
<p>Returns true if a line of data can be read from the socket; otherwise returns false.</p>
<p><b>See also </b><a href="qiodevice.html#readLine">readLine</a>().</p>
<!-- @@@canReadLine -->
<!-- $$$close[overload1]$$$close -->
<h3 class="fn"><a name="close"></a><span class="type">void</span> QAbstractSocket::<span class="name">close</span> ()<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#close">QIODevice::close</a>().</p>
<p>Closes the I/O device for the socket, disconnects the socket's connection with the host, closes the socket, and resets the name, address, port number and underlying socket descriptor.</p>
<p>See <a href="qiodevice.html#close">QIODevice::close</a>() for a description of the actions that occur when an I/O device is closed.</p>
<p><b>See also </b><a href="qabstractsocket.html#abort">abort</a>().</p>
<!-- @@@close -->
<!-- $$$connectToHost[overload1]$$$connectToHostconstQString&quint16OpenMode -->
<h3 class="fn"><a name="connectToHost"></a><span class="type">void</span> QAbstractSocket::<span class="name">connectToHost</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>hostName</i>, <span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> <i>port</i>, <span class="type"><a href="qiodevice.html#OpenModeFlag-enum">OpenMode</a></span> <i>openMode</i> = ReadWrite )</h3>
<p>Attempts to make a connection to <i>hostName</i> on the given <i>port</i>.</p>
<p>The socket is opened in the given <i>openMode</i> and first enters <a href="qabstractsocket.html#SocketState-enum">HostLookupState</a>, then performs a host name lookup of <i>hostName</i>. If the lookup succeeds, <a href="qabstractsocket.html#hostFound">hostFound</a>() is emitted and <a href="qabstractsocket.html">QAbstractSocket</a> enters <a href="qabstractsocket.html#SocketState-enum">ConnectingState</a>. It then attempts to connect to the address or addresses returned by the lookup. Finally, if a connection is established, <a href="qabstractsocket.html">QAbstractSocket</a> enters <a href="qabstractsocket.html#SocketState-enum">ConnectedState</a> and emits <a href="qabstractsocket.html#connected">connected</a>().</p>
<p>At any point, the socket can emit <a href="qabstractsocket.html#error">error</a>() to signal that an error occurred.</p>
<p><i>hostName</i> may be an IP address in string form (e.g., "43.195.83.32"), or it may be a host name (e.g., "example.com"). <a href="qabstractsocket.html">QAbstractSocket</a> will do a lookup only if required. <i>port</i> is in native byte order.</p>
<p><b>See also </b><a href="qabstractsocket.html#state">state</a>(), <a href="qabstractsocket.html#peerName">peerName</a>(), <a href="qabstractsocket.html#peerAddress">peerAddress</a>(), <a href="qabstractsocket.html#peerPort">peerPort</a>(), and <a href="qabstractsocket.html#waitForConnected">waitForConnected</a>().</p>
<!-- @@@connectToHost -->
<!-- $$$connectToHost$$$connectToHostconstQHostAddress&quint16OpenMode -->
<h3 class="fn"><a name="connectToHost-2"></a><span class="type">void</span> QAbstractSocket::<span class="name">connectToHost</span> ( const <span class="type"><a href="qhostaddress.html">QHostAddress</a></span> & <i>address</i>, <span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> <i>port</i>, <span class="type"><a href="qiodevice.html#OpenModeFlag-enum">OpenMode</a></span> <i>openMode</i> = ReadWrite )</h3>
<p>This is an overloaded function.</p>
<p>Attempts to make a connection to <i>address</i> on port <i>port</i>.</p>
<!-- @@@connectToHost -->
<!-- $$$connectToHostImplementation[overload1]$$$connectToHostImplementationconstQString&quint16OpenMode -->
<h3 class="fn"><a name="connectToHostImplementation"></a><span class="type">void</span> QAbstractSocket::<span class="name">connectToHostImplementation</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>hostName</i>, <span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> <i>port</i>, <span class="type"><a href="qiodevice.html#OpenModeFlag-enum">OpenMode</a></span> <i>openMode</i> = ReadWrite )<tt> [protected slot]</tt></h3>
<p>Contains the implementation of <a href="qabstractsocket.html#connectToHost">connectToHost</a>().</p>
<p>Attempts to make a connection to <i>hostName</i> on the given <i>port</i>. The socket is opened in the given <i>openMode</i>.</p>
<p>This function was introduced in Qt 4.1.</p>
<!-- @@@connectToHostImplementation -->
<!-- $$$connected[overload1]$$$connected -->
<h3 class="fn"><a name="connected"></a><span class="type">void</span> QAbstractSocket::<span class="name">connected</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted after <a href="qabstractsocket.html#connectToHost">connectToHost</a>() has been called and a connection has been successfully established.</p>
<p><b>Note:</b> On some operating systems the connected() signal may be directly emitted from the <a href="qabstractsocket.html#connectToHost">connectToHost</a>() call for connections to the localhost.</p>
<p><b>See also </b><a href="qabstractsocket.html#connectToHost">connectToHost</a>() and <a href="qabstractsocket.html#disconnected">disconnected</a>().</p>
<!-- @@@connected -->
<!-- $$$disconnectFromHost[overload1]$$$disconnectFromHost -->
<h3 class="fn"><a name="disconnectFromHost"></a><span class="type">void</span> QAbstractSocket::<span class="name">disconnectFromHost</span> ()</h3>
<p>Attempts to close the socket. If there is pending data waiting to be written, <a href="qabstractsocket.html">QAbstractSocket</a> will enter <a href="qabstractsocket.html#SocketState-enum">ClosingState</a> and wait until all data has been written. Eventually, it will enter <a href="qabstractsocket.html#SocketState-enum">UnconnectedState</a> and emit the <a href="qabstractsocket.html#disconnected">disconnected</a>() signal.</p>
<p><b>See also </b><a href="qabstractsocket.html#connectToHost">connectToHost</a>().</p>
<!-- @@@disconnectFromHost -->
<!-- $$$disconnectFromHostImplementation[overload1]$$$disconnectFromHostImplementation -->
<h3 class="fn"><a name="disconnectFromHostImplementation"></a><span class="type">void</span> QAbstractSocket::<span class="name">disconnectFromHostImplementation</span> ()<tt> [protected slot]</tt></h3>
<p>Contains the implementation of <a href="qabstractsocket.html#disconnectFromHost">disconnectFromHost</a>().</p>
<p>This function was introduced in Qt 4.1.</p>
<!-- @@@disconnectFromHostImplementation -->
<!-- $$$disconnected[overload1]$$$disconnected -->
<h3 class="fn"><a name="disconnected"></a><span class="type">void</span> QAbstractSocket::<span class="name">disconnected</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted when the socket has been disconnected.</p>
<p><b>Warning:</b> If you need to delete the <a href="qobject.html#sender">sender</a>() of this signal in a slot connected to it, use the <a href="qobject.html#deleteLater">deleteLater()</a> function.</p>
<p><b>See also </b><a href="qabstractsocket.html#connectToHost">connectToHost</a>(), <a href="qabstractsocket.html#disconnectFromHost">disconnectFromHost</a>(), and <a href="qabstractsocket.html#abort">abort</a>().</p>
<!-- @@@disconnected -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn"><a name="error"></a><span class="type"><a href="qabstractsocket.html#SocketError-enum">SocketError</a></span> QAbstractSocket::<span class="name">error</span> () const</h3>
<p>Returns the type of error that last occurred.</p>
<p><b>See also </b><a href="qabstractsocket.html#state">state</a>() and <a href="qiodevice.html#errorString">errorString</a>().</p>
<!-- @@@error -->
<!-- $$$error$$$errorQAbstractSocket::SocketError -->
<h3 class="fn"><a name="error-2"></a><span class="type">void</span> QAbstractSocket::<span class="name">error</span> ( <span class="type"><a href="qabstractsocket.html#SocketError-enum">QAbstractSocket::SocketError</a></span> <i>socketError</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted after an error occurred. The <i>socketError</i> parameter describes the type of error that occurred.</p>
<p><a href="qabstractsocket.html#SocketError-enum">QAbstractSocket::SocketError</a> is not a registered metatype, so for queued connections, you will have to register it with <a href="qmetatype.html#Q_DECLARE_METATYPE">Q_DECLARE_METATYPE</a>() and <a href="qmetatype.html#qRegisterMetaType">qRegisterMetaType</a>().</p>
<p><b>See also </b><a href="qabstractsocket.html#error">error</a>(), <a href="qiodevice.html#errorString">errorString</a>(), and <a href="custom-types.html">Creating Custom Qt Types</a>.</p>
<!-- @@@error -->
<!-- $$$flush[overload1]$$$flush -->
<h3 class="fn"><a name="flush"></a><span class="type">bool</span> QAbstractSocket::<span class="name">flush</span> ()</h3>
<p>This function writes as much as possible from the internal write buffer to the underlying network socket, without blocking. If any data was written, this function returns true; otherwise false is returned.</p>
<p>Call this function if you need <a href="qabstractsocket.html">QAbstractSocket</a> to start sending buffered data immediately. The number of bytes successfully written depends on the operating system. In most cases, you do not need to call this function, because <a href="qabstractsocket.html">QAbstractSocket</a> will start sending data automatically once control goes back to the event loop. In the absence of an event loop, call <a href="qabstractsocket.html#waitForBytesWritten">waitForBytesWritten</a>() instead.</p>
<p><b>See also </b><a href="qiodevice.html#write">write</a>() and <a href="qabstractsocket.html#waitForBytesWritten">waitForBytesWritten</a>().</p>
<!-- @@@flush -->
<!-- $$$hostFound[overload1]$$$hostFound -->
<h3 class="fn"><a name="hostFound"></a><span class="type">void</span> QAbstractSocket::<span class="name">hostFound</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted after <a href="qabstractsocket.html#connectToHost">connectToHost</a>() has been called and the host lookup has succeeded.</p>
<p><b>Note:</b> Since Qt 4.6.3 <a href="qabstractsocket.html">QAbstractSocket</a> may emit hostFound() directly from the <a href="qabstractsocket.html#connectToHost">connectToHost</a>() call since a DNS result could have been cached.</p>
<p><b>See also </b><a href="qabstractsocket.html#connected">connected</a>().</p>
<!-- @@@hostFound -->
<!-- $$$isSequential[overload1]$$$isSequential -->
<h3 class="fn"><a name="isSequential"></a><span class="type">bool</span> QAbstractSocket::<span class="name">isSequential</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#isSequential">QIODevice::isSequential</a>().</p>
<!-- @@@isSequential -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QAbstractSocket::<span class="name">isValid</span> () const</h3>
<p>Returns true if the socket is valid and ready for use; otherwise returns false.</p>
<p><b>Note:</b> The socket's state must be <a href="qabstractsocket.html#SocketState-enum">ConnectedState</a> before reading and writing can occur.</p>
<p><b>See also </b><a href="qabstractsocket.html#state">state</a>().</p>
<!-- @@@isValid -->
<!-- $$$localAddress[overload1]$$$localAddress -->
<h3 class="fn"><a name="localAddress"></a><span class="type"><a href="qhostaddress.html">QHostAddress</a></span> QAbstractSocket::<span class="name">localAddress</span> () const</h3>
<p>Returns the host address of the local socket if available; otherwise returns <a href="qhostaddress.html#SpecialAddress-enum">QHostAddress::Null</a>.</p>
<p>This is normally the main IP address of the host, but can be <a href="qhostaddress.html#SpecialAddress-enum">QHostAddress::LocalHost</a> (127.0.0.1) for connections to the local host.</p>
<p><b>See also </b><a href="qabstractsocket.html#localPort">localPort</a>(), <a href="qabstractsocket.html#peerAddress">peerAddress</a>(), and <a href="qabstractsocket.html#setLocalAddress">setLocalAddress</a>().</p>
<!-- @@@localAddress -->
<!-- $$$localPort[overload1]$$$localPort -->
<h3 class="fn"><a name="localPort"></a><span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> QAbstractSocket::<span class="name">localPort</span> () const</h3>
<p>Returns the host port number (in native byte order) of the local socket if available; otherwise returns 0.</p>
<p><b>See also </b><a href="qabstractsocket.html#localAddress">localAddress</a>(), <a href="qabstractsocket.html#peerPort">peerPort</a>(), and <a href="qabstractsocket.html#setLocalPort">setLocalPort</a>().</p>
<!-- @@@localPort -->
<!-- $$$peerAddress[overload1]$$$peerAddress -->
<h3 class="fn"><a name="peerAddress"></a><span class="type"><a href="qhostaddress.html">QHostAddress</a></span> QAbstractSocket::<span class="name">peerAddress</span> () const</h3>
<p>Returns the address of the connected peer if the socket is in <a href="qabstractsocket.html#SocketState-enum">ConnectedState</a>; otherwise returns <a href="qhostaddress.html#SpecialAddress-enum">QHostAddress::Null</a>.</p>
<p><b>See also </b><a href="qabstractsocket.html#peerName">peerName</a>(), <a href="qabstractsocket.html#peerPort">peerPort</a>(), <a href="qabstractsocket.html#localAddress">localAddress</a>(), and <a href="qabstractsocket.html#setPeerAddress">setPeerAddress</a>().</p>
<!-- @@@peerAddress -->
<!-- $$$peerName[overload1]$$$peerName -->
<h3 class="fn"><a name="peerName"></a><span class="type"><a href="qstring.html">QString</a></span> QAbstractSocket::<span class="name">peerName</span> () const</h3>
<p>Returns the name of the peer as specified by <a href="qabstractsocket.html#connectToHost">connectToHost</a>(), or an empty <a href="qstring.html">QString</a> if <a href="qabstractsocket.html#connectToHost">connectToHost</a>() has not been called.</p>
<p><b>See also </b><a href="qabstractsocket.html#peerAddress">peerAddress</a>(), <a href="qabstractsocket.html#peerPort">peerPort</a>(), and <a href="qabstractsocket.html#setPeerName">setPeerName</a>().</p>
<!-- @@@peerName -->
<!-- $$$peerPort[overload1]$$$peerPort -->
<h3 class="fn"><a name="peerPort"></a><span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> QAbstractSocket::<span class="name">peerPort</span> () const</h3>
<p>Returns the port of the connected peer if the socket is in <a href="qabstractsocket.html#SocketState-enum">ConnectedState</a>; otherwise returns 0.</p>
<p><b>See also </b><a href="qabstractsocket.html#peerAddress">peerAddress</a>(), <a href="qabstractsocket.html#localPort">localPort</a>(), and <a href="qabstractsocket.html#setPeerPort">setPeerPort</a>().</p>
<!-- @@@peerPort -->
<!-- $$$proxy[overload1]$$$proxy -->
<h3 class="fn"><a name="proxy"></a><span class="type"><a href="qnetworkproxy.html">QNetworkProxy</a></span> QAbstractSocket::<span class="name">proxy</span> () const</h3>
<p>Returns the network proxy for this socket. By default <a href="qnetworkproxy.html#ProxyType-enum">QNetworkProxy::DefaultProxy</a> is used, which means this socket will query the default proxy settings for the application.</p>
<p>This function was introduced in Qt 4.1.</p>
<p><b>See also </b><a href="qabstractsocket.html#setProxy">setProxy</a>(), <a href="qnetworkproxy.html">QNetworkProxy</a>, and <a href="qnetworkproxyfactory.html">QNetworkProxyFactory</a>.</p>
<!-- @@@proxy -->
<!-- $$$proxyAuthenticationRequired[overload1]$$$proxyAuthenticationRequiredconstQNetworkProxy&QAuthenticator* -->
<h3 class="fn"><a name="proxyAuthenticationRequired"></a><span class="type">void</span> QAbstractSocket::<span class="name">proxyAuthenticationRequired</span> ( const <span class="type"><a href="qnetworkproxy.html">QNetworkProxy</a></span> & <i>proxy</i>, <span class="type"><a href="qauthenticator.html">QAuthenticator</a></span> * <i>authenticator</i> )<tt> [signal]</tt></h3>
<p>This signal can be emitted when a <i>proxy</i> that requires authentication is used. The <i>authenticator</i> object can then be filled in with the required details to allow authentication and continue the connection.</p>
<p><b>Note:</b> It is not possible to use a QueuedConnection to connect to this signal, as the connection will fail if the authenticator has not been filled in with new information when the signal returns.</p>
<p>This function was introduced in Qt 4.3.</p>
<p><b>See also </b><a href="qauthenticator.html">QAuthenticator</a> and <a href="qnetworkproxy.html">QNetworkProxy</a>.</p>
<!-- @@@proxyAuthenticationRequired -->
<!-- $$$readBufferSize[overload1]$$$readBufferSize -->
<h3 class="fn"><a name="readBufferSize"></a><span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> QAbstractSocket::<span class="name">readBufferSize</span> () const</h3>
<p>Returns the size of the internal read buffer. This limits the amount of data that the client can receive before you call <a href="qiodevice.html#read">read</a>() or <a href="qiodevice.html#readAll">readAll</a>().</p>
<p>A read buffer size of 0 (the default) means that the buffer has no size limit, ensuring that no data is lost.</p>
<p><b>See also </b><a href="qabstractsocket.html#setReadBufferSize">setReadBufferSize</a>() and <a href="qiodevice.html#read">read</a>().</p>
<!-- @@@readBufferSize -->
<!-- $$$readData[overload1]$$$readDatachar*qint64 -->
<h3 class="fn"><a name="readData"></a><span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> QAbstractSocket::<span class="name">readData</span> ( <span class="type">char</span> * <i>data</i>, <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> <i>maxSize</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#readData">QIODevice::readData</a>().</p>
<!-- @@@readData -->
<!-- $$$readLineData[overload1]$$$readLineDatachar*qint64 -->
<h3 class="fn"><a name="readLineData"></a><span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> QAbstractSocket::<span class="name">readLineData</span> ( <span class="type">char</span> * <i>data</i>, <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> <i>maxlen</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#readLineData">QIODevice::readLineData</a>().</p>
<!-- @@@readLineData -->
<!-- $$$setLocalAddress[overload1]$$$setLocalAddressconstQHostAddress& -->
<h3 class="fn"><a name="setLocalAddress"></a><span class="type">void</span> QAbstractSocket::<span class="name">setLocalAddress</span> ( const <span class="type"><a href="qhostaddress.html">QHostAddress</a></span> & <i>address</i> )<tt> [protected]</tt></h3>
<p>Sets the address on the local side of a connection to <i>address</i>.</p>
<p>You can call this function in a subclass of <a href="qabstractsocket.html">QAbstractSocket</a> to change the return value of the <a href="qabstractsocket.html#localAddress">localAddress</a>() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.</p>
<p>Note that this function does not bind the local address of the socket prior to a connection (e.g., <a href="qudpsocket.html#bind">QUdpSocket::bind</a>()).</p>
<p>This function was introduced in Qt 4.1.</p>
<p><b>See also </b><a href="qabstractsocket.html#localAddress">localAddress</a>(), <a href="qabstractsocket.html#setLocalPort">setLocalPort</a>(), and <a href="qabstractsocket.html#setPeerAddress">setPeerAddress</a>().</p>
<!-- @@@setLocalAddress -->
<!-- $$$setLocalPort[overload1]$$$setLocalPortquint16 -->
<h3 class="fn"><a name="setLocalPort"></a><span class="type">void</span> QAbstractSocket::<span class="name">setLocalPort</span> ( <span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> <i>port</i> )<tt> [protected]</tt></h3>
<p>Sets the port on the local side of a connection to <i>port</i>.</p>
<p>You can call this function in a subclass of <a href="qabstractsocket.html">QAbstractSocket</a> to change the return value of the <a href="qabstractsocket.html#localPort">localPort</a>() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.</p>
<p>Note that this function does not bind the local port of the socket prior to a connection (e.g., <a href="qudpsocket.html#bind">QUdpSocket::bind</a>()).</p>
<p>This function was introduced in Qt 4.1.</p>
<p><b>See also </b><a href="qabstractsocket.html#localPort">localPort</a>(), <a href="qabstractsocket.html#localAddress">localAddress</a>(), <a href="qabstractsocket.html#setLocalAddress">setLocalAddress</a>(), and <a href="qabstractsocket.html#setPeerPort">setPeerPort</a>().</p>
<!-- @@@setLocalPort -->
<!-- $$$setPeerAddress[overload1]$$$setPeerAddressconstQHostAddress& -->
<h3 class="fn"><a name="setPeerAddress"></a><span class="type">void</span> QAbstractSocket::<span class="name">setPeerAddress</span> ( const <span class="type"><a href="qhostaddress.html">QHostAddress</a></span> & <i>address</i> )<tt> [protected]</tt></h3>
<p>Sets the address of the remote side of the connection to <i>address</i>.</p>
<p>You can call this function in a subclass of <a href="qabstractsocket.html">QAbstractSocket</a> to change the return value of the <a href="qabstractsocket.html#peerAddress">peerAddress</a>() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.</p>
<p>This function was introduced in Qt 4.1.</p>
<p><b>See also </b><a href="qabstractsocket.html#peerAddress">peerAddress</a>(), <a href="qabstractsocket.html#setPeerPort">setPeerPort</a>(), and <a href="qabstractsocket.html#setLocalAddress">setLocalAddress</a>().</p>
<!-- @@@setPeerAddress -->
<!-- $$$setPeerName[overload1]$$$setPeerNameconstQString& -->
<h3 class="fn"><a name="setPeerName"></a><span class="type">void</span> QAbstractSocket::<span class="name">setPeerName</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )<tt> [protected]</tt></h3>
<p>Sets the host name of the remote peer to <i>name</i>.</p>
<p>You can call this function in a subclass of <a href="qabstractsocket.html">QAbstractSocket</a> to change the return value of the <a href="qabstractsocket.html#peerName">peerName</a>() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.</p>
<p>This function was introduced in Qt 4.1.</p>
<p><b>See also </b><a href="qabstractsocket.html#peerName">peerName</a>().</p>
<!-- @@@setPeerName -->
<!-- $$$setPeerPort[overload1]$$$setPeerPortquint16 -->
<h3 class="fn"><a name="setPeerPort"></a><span class="type">void</span> QAbstractSocket::<span class="name">setPeerPort</span> ( <span class="type"><a href="qtglobal.html#quint16-typedef">quint16</a></span> <i>port</i> )<tt> [protected]</tt></h3>
<p>Sets the port of the remote side of the connection to <i>port</i>.</p>
<p>You can call this function in a subclass of <a href="qabstractsocket.html">QAbstractSocket</a> to change the return value of the <a href="qabstractsocket.html#peerPort">peerPort</a>() function after a connection has been established. This feature is commonly used by proxy connections for virtual connection settings.</p>
<p>This function was introduced in Qt 4.1.</p>
<p><b>See also </b><a href="qabstractsocket.html#peerPort">peerPort</a>(), <a href="qabstractsocket.html#setPeerAddress">setPeerAddress</a>(), and <a href="qabstractsocket.html#setLocalPort">setLocalPort</a>().</p>
<!-- @@@setPeerPort -->
<!-- $$$setProxy[overload1]$$$setProxyconstQNetworkProxy& -->
<h3 class="fn"><a name="setProxy"></a><span class="type">void</span> QAbstractSocket::<span class="name">setProxy</span> ( const <span class="type"><a href="qnetworkproxy.html">QNetworkProxy</a></span> & <i>networkProxy</i> )</h3>
<p>Sets the explicit network proxy for this socket to <i>networkProxy</i>.</p>
<p>To disable the use of a proxy for this socket, use the <a href="qnetworkproxy.html#ProxyType-enum">QNetworkProxy::NoProxy</a> proxy type:</p>
<pre class="cpp"> socket<span class="operator">-</span><span class="operator">></span>setProxy(<span class="type"><a href="qnetworkproxy.html">QNetworkProxy</a></span><span class="operator">::</span>NoProxy);</pre>
<p>The default value for the proxy is <a href="qnetworkproxy.html#ProxyType-enum">QNetworkProxy::DefaultProxy</a>, which means the socket will use the application settings: if a proxy is set with QNetworkProxy::setApplicationProxy, it will use that; otherwise, if a factory is set with QNetworkProxyFactory::setApplicationProxyFactory, it will query that factory with type <a href="qnetworkproxyquery.html#QueryType-enum">QNetworkProxyQuery::TcpSocket</a>.</p>
<p>This function was introduced in Qt 4.1.</p>
<p><b>See also </b><a href="qabstractsocket.html#proxy">proxy</a>(), <a href="qnetworkproxy.html">QNetworkProxy</a>, and <a href="qnetworkproxyfactory.html#queryProxy">QNetworkProxyFactory::queryProxy</a>().</p>
<!-- @@@setProxy -->
<!-- $$$setReadBufferSize[overload1]$$$setReadBufferSizeqint64 -->
<h3 class="fn"><a name="setReadBufferSize"></a><span class="type">void</span> QAbstractSocket::<span class="name">setReadBufferSize</span> ( <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> <i>size</i> )</h3>
<p>Sets the size of <a href="qabstractsocket.html">QAbstractSocket</a>'s internal read buffer to be <i>size</i> bytes.</p>
<p>If the buffer size is limited to a certain size, <a href="qabstractsocket.html">QAbstractSocket</a> won't buffer more than this size of data. Exceptionally, a buffer size of 0 means that the read buffer is unlimited and all incoming data is buffered. This is the default.</p>
<p>This option is useful if you only read the data at certain points in time (e.g., in a real-time streaming application) or if you want to protect your socket against receiving too much data, which may eventually cause your application to run out of memory.</p>
<p>Only <a href="qtcpsocket.html">QTcpSocket</a> uses <a href="qabstractsocket.html">QAbstractSocket</a>'s internal buffer; <a href="qudpsocket.html">QUdpSocket</a> does not use any buffering at all, but rather relies on the implicit buffering provided by the operating system. Because of this, calling this function on <a href="qudpsocket.html">QUdpSocket</a> has no effect.</p>
<p><b>See also </b><a href="qabstractsocket.html#readBufferSize">readBufferSize</a>() and <a href="qiodevice.html#read">read</a>().</p>
<!-- @@@setReadBufferSize -->
<!-- $$$setSocketDescriptor[overload1]$$$setSocketDescriptorintSocketStateOpenMode -->
<h3 class="fn"><a name="setSocketDescriptor"></a><span class="type">bool</span> QAbstractSocket::<span class="name">setSocketDescriptor</span> ( <span class="type">int</span> <i>socketDescriptor</i>, <span class="type"><a href="qabstractsocket.html#SocketState-enum">SocketState</a></span> <i>socketState</i> = ConnectedState, <span class="type"><a href="qiodevice.html#OpenModeFlag-enum">OpenMode</a></span> <i>openMode</i> = ReadWrite )</h3>
<p>Initializes <a href="qabstractsocket.html">QAbstractSocket</a> with the native socket descriptor <i>socketDescriptor</i>. Returns true if <i>socketDescriptor</i> is accepted as a valid socket descriptor; otherwise returns false. The socket is opened in the mode specified by <i>openMode</i>, and enters the socket state specified by <i>socketState</i>.</p>
<p><b>Note:</b> It is not possible to initialize two abstract sockets with the same native socket descriptor.</p>
<p><b>See also </b><a href="qabstractsocket.html#socketDescriptor">socketDescriptor</a>().</p>
<!-- @@@setSocketDescriptor -->
<!-- $$$setSocketError[overload1]$$$setSocketErrorSocketError -->
<h3 class="fn"><a name="setSocketError"></a><span class="type">void</span> QAbstractSocket::<span class="name">setSocketError</span> ( <span class="type"><a href="qabstractsocket.html#SocketError-enum">SocketError</a></span> <i>socketError</i> )<tt> [protected]</tt></h3>
<p>Sets the type of error that last occurred to <i>socketError</i>.</p>
<p><b>See also </b><a href="qabstractsocket.html#setSocketState">setSocketState</a>() and <a href="qiodevice.html#setErrorString">setErrorString</a>().</p>
<!-- @@@setSocketError -->
<!-- $$$setSocketOption[overload1]$$$setSocketOptionQAbstractSocket::SocketOptionconstQVariant& -->
<h3 class="fn"><a name="setSocketOption"></a><span class="type">void</span> QAbstractSocket::<span class="name">setSocketOption</span> ( <span class="type"><a href="qabstractsocket.html#SocketOption-enum">QAbstractSocket::SocketOption</a></span> <i>option</i>, const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>value</i> )</h3>
<p>Sets the given <i>option</i> to the value described by <i>value</i>.</p>
<p>This function was introduced in Qt 4.6.</p>
<p><b>See also </b><a href="qabstractsocket.html#socketOption">socketOption</a>().</p>
<!-- @@@setSocketOption -->
<!-- $$$setSocketState[overload1]$$$setSocketStateSocketState -->
<h3 class="fn"><a name="setSocketState"></a><span class="type">void</span> QAbstractSocket::<span class="name">setSocketState</span> ( <span class="type"><a href="qabstractsocket.html#SocketState-enum">SocketState</a></span> <i>state</i> )<tt> [protected]</tt></h3>
<p>Sets the state of the socket to <i>state</i>.</p>
<p><b>See also </b><a href="qabstractsocket.html#state">state</a>().</p>
<!-- @@@setSocketState -->
<!-- $$$socketDescriptor[overload1]$$$socketDescriptor -->
<h3 class="fn"><a name="socketDescriptor"></a><span class="type">int</span> QAbstractSocket::<span class="name">socketDescriptor</span> () const</h3>
<p>Returns the native socket descriptor of the <a href="qabstractsocket.html">QAbstractSocket</a> object if this is available; otherwise returns -1.</p>
<p>If the socket is using <a href="qnetworkproxy.html">QNetworkProxy</a>, the returned descriptor may not be usable with native socket functions.</p>
<p>The socket descriptor is not available when <a href="qabstractsocket.html">QAbstractSocket</a> is in <a href="qabstractsocket.html#SocketState-enum">UnconnectedState</a>.</p>
<p><b>See also </b><a href="qabstractsocket.html#setSocketDescriptor">setSocketDescriptor</a>().</p>
<!-- @@@socketDescriptor -->
<!-- $$$socketOption[overload1]$$$socketOptionQAbstractSocket::SocketOption -->
<h3 class="fn"><a name="socketOption"></a><span class="type"><a href="qvariant.html">QVariant</a></span> QAbstractSocket::<span class="name">socketOption</span> ( <span class="type"><a href="qabstractsocket.html#SocketOption-enum">QAbstractSocket::SocketOption</a></span> <i>option</i> )</h3>
<p>Returns the value of the <i>option</i> option.</p>
<p>This function was introduced in Qt 4.6.</p>
<p><b>See also </b><a href="qabstractsocket.html#setSocketOption">setSocketOption</a>().</p>
<!-- @@@socketOption -->
<!-- $$$socketType[overload1]$$$socketType -->
<h3 class="fn"><a name="socketType"></a><span class="type"><a href="qabstractsocket.html#SocketType-enum">SocketType</a></span> QAbstractSocket::<span class="name">socketType</span> () const</h3>
<p>Returns the socket type (TCP, UDP, or other).</p>
<p><b>See also </b><a href="qtcpsocket.html">QTcpSocket</a> and <a href="qudpsocket.html">QUdpSocket</a>.</p>
<!-- @@@socketType -->
<!-- $$$state[overload1]$$$state -->
<h3 class="fn"><a name="state"></a><span class="type"><a href="qabstractsocket.html#SocketState-enum">SocketState</a></span> QAbstractSocket::<span class="name">state</span> () const</h3>
<p>Returns the state of the socket.</p>
<p><b>See also </b><a href="qabstractsocket.html#error">error</a>().</p>
<!-- @@@state -->
<!-- $$$stateChanged[overload1]$$$stateChangedQAbstractSocket::SocketState -->
<h3 class="fn"><a name="stateChanged"></a><span class="type">void</span> QAbstractSocket::<span class="name">stateChanged</span> ( <span class="type"><a href="qabstractsocket.html#SocketState-enum">QAbstractSocket::SocketState</a></span> <i>socketState</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted whenever <a href="qabstractsocket.html">QAbstractSocket</a>'s state changes. The <i>socketState</i> parameter is the new state.</p>
<p><a href="qabstractsocket.html#SocketState-enum">QAbstractSocket::SocketState</a> is not a registered metatype, so for queued connections, you will have to register it with Q_REGISTER_METATYPE() and <a href="qmetatype.html#qRegisterMetaType">qRegisterMetaType</a>().</p>
<p><b>See also </b><a href="qabstractsocket.html#state">state</a>() and <a href="custom-types.html">Creating Custom Qt Types</a>.</p>
<!-- @@@stateChanged -->
<!-- $$$waitForBytesWritten[overload1]$$$waitForBytesWrittenint -->
<h3 class="fn"><a name="waitForBytesWritten"></a><span class="type">bool</span> QAbstractSocket::<span class="name">waitForBytesWritten</span> ( <span class="type">int</span> <i>msecs</i> = 30000 )<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#waitForBytesWritten">QIODevice::waitForBytesWritten</a>().</p>
<!-- @@@waitForBytesWritten -->
<!-- $$$waitForConnected[overload1]$$$waitForConnectedint -->
<h3 class="fn"><a name="waitForConnected"></a><span class="type">bool</span> QAbstractSocket::<span class="name">waitForConnected</span> ( <span class="type">int</span> <i>msecs</i> = 30000 )</h3>
<p>Waits until the socket is connected, up to <i>msecs</i> milliseconds. If the connection has been established, this function returns true; otherwise it returns false. In the case where it returns false, you can call <a href="qabstractsocket.html#error">error</a>() to determine the cause of the error.</p>
<p>The following example waits up to one second for a connection to be established:</p>
<pre class="cpp"> socket<span class="operator">-</span><span class="operator">></span><a href="qabstractsocket.html#connectToHost">connectToHost</a>(<span class="string">"imap"</span><span class="operator">,</span> <span class="number">143</span>);
<span class="keyword">if</span> (socket<span class="operator">-</span><span class="operator">></span>waitForConnected(<span class="number">1000</span>))
<a href="qtglobal.html#qDebug">qDebug</a>(<span class="string">"Connected!"</span>);</pre>
<p>If msecs is -1, this function will not time out.</p>
<p><b>Note:</b> This function may wait slightly longer than <i>msecs</i>, depending on the time it takes to complete the host lookup.</p>
<p><b>Note:</b> Multiple calls to this functions do not accumulate the time. If the function times out, the connecting process will be aborted.</p>
<p><b>See also </b><a href="qabstractsocket.html#connectToHost">connectToHost</a>() and <a href="qabstractsocket.html#connected">connected</a>().</p>
<!-- @@@waitForConnected -->
<!-- $$$waitForDisconnected[overload1]$$$waitForDisconnectedint -->
<h3 class="fn"><a name="waitForDisconnected"></a><span class="type">bool</span> QAbstractSocket::<span class="name">waitForDisconnected</span> ( <span class="type">int</span> <i>msecs</i> = 30000 )</h3>
<p>Waits until the socket has disconnected, up to <i>msecs</i> milliseconds. If the connection has been disconnected, this function returns true; otherwise it returns false. In the case where it returns false, you can call <a href="qabstractsocket.html#error">error</a>() to determine the cause of the error.</p>
<p>The following example waits up to one second for a connection to be closed:</p>
<pre class="cpp"> socket<span class="operator">-</span><span class="operator">></span><a href="qabstractsocket.html#disconnectFromHost">disconnectFromHost</a>();
<span class="keyword">if</span> (socket<span class="operator">-</span><span class="operator">></span>state() <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qabstractsocket.html">QAbstractSocket</a></span><span class="operator">::</span>UnconnectedState <span class="operator">|</span><span class="operator">|</span>
socket<span class="operator">-</span><span class="operator">></span>waitForDisconnected(<span class="number">1000</span>))
<a href="qtglobal.html#qDebug">qDebug</a>(<span class="string">"Disconnected!"</span>);</pre>
<p>If msecs is -1, this function will not time out.</p>
<p><b>See also </b><a href="qabstractsocket.html#disconnectFromHost">disconnectFromHost</a>() and <a href="qabstractsocket.html#close">close</a>().</p>
<!-- @@@waitForDisconnected -->
<!-- $$$waitForReadyRead[overload1]$$$waitForReadyReadint -->
<h3 class="fn"><a name="waitForReadyRead"></a><span class="type">bool</span> QAbstractSocket::<span class="name">waitForReadyRead</span> ( <span class="type">int</span> <i>msecs</i> = 30000 )<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#waitForReadyRead">QIODevice::waitForReadyRead</a>().</p>
<p>This function blocks until new data is available for reading and the <a href="qiodevice.html#readyRead">readyRead()</a> signal has been emitted. The function will timeout after <i>msecs</i> milliseconds; the default timeout is 30000 milliseconds.</p>
<p>The function returns true if the <a href="qiodevice.html#readyRead">readyRead</a>() signal is emitted and there is new data available for reading; otherwise it returns false (if an error occurred or the operation timed out).</p>
<p><b>See also </b><a href="qabstractsocket.html#waitForBytesWritten">waitForBytesWritten</a>().</p>
<!-- @@@waitForReadyRead -->
<!-- $$$writeData[overload1]$$$writeDataconstchar*qint64 -->
<h3 class="fn"><a name="writeData"></a><span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> QAbstractSocket::<span class="name">writeData</span> ( const <span class="type">char</span> * <i>data</i>, <span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> <i>size</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qiodevice.html#writeData">QIODevice::writeData</a>().</p>
<!-- @@@writeData -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
