<?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" />
<!-- q3serversocket.cpp -->
<title>Qt 4.8: Q3ServerSocket 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="qt3support.html">Qt3Support</a></li>
<li>Q3ServerSocket</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-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3ServerSocket Class Reference</h1>
<!-- $$$Q3ServerSocket-brief -->
<p>The Q3ServerSocket class provides a TCP-based server. <a href="#details">More...</a></p>
<!-- @@@Q3ServerSocket -->
<pre class="cpp"> <span class="preprocessor">#include <Q3ServerSocket></span></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html#qserversocket">Porting to Qt 4</a> for more information.</p>
<p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p>
<ul>
<li><a href="q3serversocket-members.html">List of all members, including inherited members</a></li>
</ul>
<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="q3serversocket.html#Q3ServerSocket">Q3ServerSocket</a></b> ( Q_UINT16 <i>port</i>, int <i>backlog</i> = 1, QObject * <i>parent</i> = 0, const char * <i>name</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#Q3ServerSocket-2">Q3ServerSocket</a></b> ( const QHostAddress & <i>address</i>, Q_UINT16 <i>port</i>, int <i>backlog</i> = 1, QObject * <i>parent</i> = 0, const char * <i>name</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#Q3ServerSocket-3">Q3ServerSocket</a></b> ( QObject * <i>parent</i> = 0, const char * <i>name</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#dtor.Q3ServerSocket">~Q3ServerSocket</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHostAddress </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#address">address</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#newConnection">newConnection</a></b> ( int <i>socket</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#ok">ok</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q_UINT16 </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#port">port</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#setSocket">setSocket</a></b> ( int <i>socket</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#socket">socket</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Q3SocketDevice * </td><td class="memItemRight bottomAlign"><b><a href="q3serversocket.html#socketDevice">socketDevice</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<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">1 signal inherited from <a href="qobject.html#signals">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>
<!-- $$$Q3ServerSocket-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3ServerSocket class provides a TCP-based server.</p>
<p>This class is a convenience class for accepting incoming TCP connections. You can specify the port or have Q3ServerSocket pick one, and listen on just one address or on all the machine's addresses.</p>
<p>Using the API is very simple: subclass Q3ServerSocket, call the constructor of your choice, and implement <a href="q3serversocket.html#newConnection">newConnection</a>() to handle new incoming connections. There is nothing more to do.</p>
<p>(Note that due to lack of support in the underlying APIs, Q3ServerSocket cannot accept or reject connections conditionally.)</p>
</div>
<p><b>See also </b><a href="q3socket.html">Q3Socket</a>, <a href="q3socketdevice.html">Q3SocketDevice</a>, <a href="qhostaddress.html">QHostAddress</a>, and <a href="qsocketnotifier.html">QSocketNotifier</a>.</p>
<!-- @@@Q3ServerSocket -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3ServerSocket[overload1]$$$Q3ServerSocketQ_UINT16intQObject*constchar* -->
<h3 class="fn"><a name="Q3ServerSocket"></a>Q3ServerSocket::<span class="name">Q3ServerSocket</span> ( <span class="type"><a href="qtglobal-qt3.html#Q_UINT16-typedef">Q_UINT16</a></span> <i>port</i>, <span class="type">int</span> <i>backlog</i> = 1, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0, const <span class="type">char</span> * <i>name</i> = 0 )</h3>
<p>Creates a server socket object, that will serve the given <i>port</i> on all the addresses of this host. If <i>port</i> is 0, <a href="q3serversocket.html" class="compat">Q3ServerSocket</a> will pick a suitable port in a system-dependent manner. Use <i>backlog</i> to specify how many pending connections the server can have.</p>
<p>The <i>parent</i> and <i>name</i> arguments are passed on to the <a href="qobject.html">QObject</a> constructor.</p>
<p><b>Warning:</b> On Tru64 Unix systems a value of 0 for <i>backlog</i> means that you don't accept any connections at all; you should specify a value larger than 0.</p>
<!-- @@@Q3ServerSocket -->
<!-- $$$Q3ServerSocket$$$Q3ServerSocketconstQHostAddress&Q_UINT16intQObject*constchar* -->
<h3 class="fn"><a name="Q3ServerSocket-2"></a>Q3ServerSocket::<span class="name">Q3ServerSocket</span> ( const <span class="type"><a href="qhostaddress.html">QHostAddress</a></span> & <i>address</i>, <span class="type"><a href="qtglobal-qt3.html#Q_UINT16-typedef">Q_UINT16</a></span> <i>port</i>, <span class="type">int</span> <i>backlog</i> = 1, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0, const <span class="type">char</span> * <i>name</i> = 0 )</h3>
<p>Creates a server socket object, that will serve the given <i>port</i> only on the given <i>address</i>. Use <i>backlog</i> to specify how many pending connections the server can have.</p>
<p>The <i>parent</i> and <i>name</i> arguments are passed on to the <a href="qobject.html">QObject</a> constructor.</p>
<p><b>Warning:</b> On Tru64 Unix systems a value of 0 for <i>backlog</i> means that you don't accept any connections at all; you should specify a value larger than 0.</p>
<!-- @@@Q3ServerSocket -->
<!-- $$$Q3ServerSocket$$$Q3ServerSocketQObject*constchar* -->
<h3 class="fn"><a name="Q3ServerSocket-3"></a>Q3ServerSocket::<span class="name">Q3ServerSocket</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0, const <span class="type">char</span> * <i>name</i> = 0 )</h3>
<p>Construct an empty server socket.</p>
<p>This constructor, in combination with <a href="q3serversocket.html#setSocket">setSocket</a>(), allows us to use the <a href="q3serversocket.html" class="compat">Q3ServerSocket</a> class as a wrapper for other socket types (e.g. Unix Domain Sockets under Unix).</p>
<p>The <i>parent</i> and <i>name</i> arguments are passed on to the <a href="qobject.html">QObject</a> constructor.</p>
<p><b>See also </b><a href="q3serversocket.html#setSocket">setSocket</a>().</p>
<!-- @@@Q3ServerSocket -->
<!-- $$$~Q3ServerSocket[overload1]$$$~Q3ServerSocket -->
<h3 class="fn"><a name="dtor.Q3ServerSocket"></a>Q3ServerSocket::<span class="name">~Q3ServerSocket</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the socket.</p>
<p>This causes any backlogged connections (connections that have reached the host, but not yet been completely set up by calling <a href="q3socketdevice.html#accept">Q3SocketDevice::accept</a>()) to be severed.</p>
<p>Existing connections continue to exist; this only affects the acceptance of new connections.</p>
<!-- @@@~Q3ServerSocket -->
<!-- $$$address[overload1]$$$address -->
<h3 class="fn"><a name="address"></a><span class="type"><a href="qhostaddress.html">QHostAddress</a></span> Q3ServerSocket::<span class="name">address</span> () const</h3>
<p>Returns the address on which this object listens, or 0.0.0.0 if this object listens on more than one address. <a href="q3serversocket.html#ok">ok</a>() must be true before calling this function.</p>
<p><b>See also </b><a href="q3serversocket.html#port">port</a>() and <a href="q3socketdevice.html#address">Q3SocketDevice::address</a>().</p>
<!-- @@@address -->
<!-- $$$newConnection[overload1]$$$newConnectionint -->
<h3 class="fn"><a name="newConnection"></a><span class="type">void</span> Q3ServerSocket::<span class="name">newConnection</span> ( <span class="type">int</span> <i>socket</i> )<tt> [pure virtual]</tt></h3>
<p>This pure virtual function is responsible for setting up a new incoming connection. <i>socket</i> is the fd (file descriptor) for the newly accepted connection.</p>
<!-- @@@newConnection -->
<!-- $$$ok[overload1]$$$ok -->
<h3 class="fn"><a name="ok"></a><span class="type">bool</span> Q3ServerSocket::<span class="name">ok</span> () const</h3>
<p>Returns true if the construction succeeded; otherwise returns false.</p>
<!-- @@@ok -->
<!-- $$$port[overload1]$$$port -->
<h3 class="fn"><a name="port"></a><span class="type"><a href="qtglobal-qt3.html#Q_UINT16-typedef">Q_UINT16</a></span> Q3ServerSocket::<span class="name">port</span> () const</h3>
<p>Returns the port number on which this server socket listens. This is always non-zero; if you specify 0 in the constructor, <a href="q3serversocket.html" class="compat">Q3ServerSocket</a> will pick a non-zero port itself. <a href="q3serversocket.html#ok">ok</a>() must be true before calling this function.</p>
<p><b>See also </b><a href="q3serversocket.html#address">address</a>() and <a href="q3socketdevice.html#port">Q3SocketDevice::port</a>().</p>
<!-- @@@port -->
<!-- $$$setSocket[overload1]$$$setSocketint -->
<h3 class="fn"><a name="setSocket"></a><span class="type">void</span> Q3ServerSocket::<span class="name">setSocket</span> ( <span class="type">int</span> <i>socket</i> )<tt> [virtual]</tt></h3>
<p>Sets the socket to use <i>socket</i>. bind() and listen() should already have been called for <i>socket</i>.</p>
<p>This allows us to use the <a href="q3serversocket.html" class="compat">Q3ServerSocket</a> class as a wrapper for other socket types (e.g. Unix Domain Sockets).</p>
<p><b>See also </b><a href="q3serversocket.html#socket">socket</a>().</p>
<!-- @@@setSocket -->
<!-- $$$socket[overload1]$$$socket -->
<h3 class="fn"><a name="socket"></a><span class="type">int</span> Q3ServerSocket::<span class="name">socket</span> () const</h3>
<p>Returns the operating system socket.</p>
<p><b>See also </b><a href="q3serversocket.html#setSocket">setSocket</a>().</p>
<!-- @@@socket -->
<!-- $$$socketDevice[overload1]$$$socketDevice -->
<h3 class="fn"><a name="socketDevice"></a><span class="type"><a href="q3socketdevice.html">Q3SocketDevice</a></span> * Q3ServerSocket::<span class="name">socketDevice</span> ()<tt> [protected]</tt></h3>
<p>Returns a pointer to the internal socket device. The returned pointer is 0 if there is no connection or pending connection.</p>
<p>There is normally no need to manipulate the socket device directly since this class does all the necessary setup for most client or server socket applications.</p>
<!-- @@@socketDevice -->
</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>
