<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /builddir/build/BUILD/libqxt/src/core/qxtabstractconnectionmanager.cpp -->
<head>
<title>QxtAbstractConnectionManager Class Reference</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtAbstractConnectionManager Class Reference<br /><span class="small-subtitle">[<a href="qxtcore.html">QxtCore</a> module]</span>
</h1>
<p>The QxtAbstractConnectionManager class is an interface for classes that maintain connection pools <a href="#details">More...</a></p>
<pre> #include <QxtAbstractConnectionManager></pre><p>Inherits <a href="http://doc.qtsoftware.com/4.5/qobject.html">QObject</a>.</p>
<p>Inherited by <a href="qxttcpconnectionmanager.html">QxtTcpConnectionManager</a>.</p>
<ul>
<li><a href="qxtabstractconnectionmanager-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtabstractconnectionmanager.html#QxtAbstractConnectionManager">QxtAbstractConnectionManager</a></b> ( QObject * <i>parent</i> )</li>
<li><div class="fn"></div>virtual <b><a href="qxtabstractconnectionmanager.html#dtor.QxtAbstractConnectionManager">~QxtAbstractConnectionManager</a></b> ()</li>
<li><div class="fn"></div>QIODevice * <b><a href="qxtabstractconnectionmanager.html#client">client</a></b> ( quint64 <i>clientID</i> ) const</li>
<li><div class="fn"></div>int <b><a href="qxtabstractconnectionmanager.html#clientCount">clientCount</a></b> () const</li>
<li><div class="fn"></div>QList<quint64> <b><a href="qxtabstractconnectionmanager.html#clients">clients</a></b> () const</li>
</ul>
<ul>
<li><div class="fn"></div>29 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h3>Public Slots</h3>
<ul>
<li><div class="fn"></div>void <b><a href="qxtabstractconnectionmanager.html#disconnect">disconnect</a></b> ( quint64 <i>clientID</i> )</li>
</ul>
<ul>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h3>Protected Functions</h3>
<ul>
<li><div class="fn"></div>void <b><a href="qxtabstractconnectionmanager.html#addConnection">addConnection</a></b> ( QIODevice * <i>device</i>, quint64 <i>clientID</i> )</li>
</ul>
<ul>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#signals">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtAbstractConnectionManager class is an interface for classes that maintain connection pools</p>
<p>QxtAbstractConnectionManager is a standardized interface for accepting and tracking incoming connections.</p>
<p>Each incoming connection is assigned an arbitrary, opaque client ID number. This number can be used to retrieve the <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a> associated with it. A list of IDs for all current connections can be retrieved with the <a href="qxtabstractconnectionmanager.html#clients">clients</a>() function.</p>
<p>As an abstract class, QxtAbstractConnectionManager cannot be used on its own. Subclasses must implement isAcceptingConnections() to indicate the current listening status of the connection manager and removeConnection() to perform necessary clean-up of an established connection before disconnecting. Finally, a subclass must invoke <a href="qxtabstractconnectionmanager.html#addConnection">addConnection</a>() after a new incoming connection has been established and prepared.</p>
<p>See also <a href="qxttcpconnectionmanager.html">QxtTcpConnectionManager</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtAbstractConnectionManager"></a>QxtAbstractConnectionManager::QxtAbstractConnectionManager ( <a href="http://doc.qtsoftware.com/4.5/qobject.html">QObject</a> * <i>parent</i> )</h3>
<p>Constructs a <a href="qxtabstractconnectionmanager.html">QxtAbstractConnectionManager</a> object with the specified <i>parent</i>.</p>
<h3 class="fn"><a name="dtor.QxtAbstractConnectionManager"></a>QxtAbstractConnectionManager::~QxtAbstractConnectionManager () <tt> [virtual]</tt></h3>
<p>Destructs the connection manager.</p>
<h3 class="fn"><a name="addConnection"></a>void QxtAbstractConnectionManager::addConnection ( <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a> * <i>device</i>, <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>clientID</i> ) <tt> [protected]</tt></h3>
<p>Begins managing a connection. Each <i>device</i> must have a unique, non-zero <i>clientID</i>, but beyond this constraint implementations may use any convenient value. Implementations should invoke this function after establishing a usable connection and performing any desired initial negotiation.</p>
<p>This function will emit the newConnection signal after the internal data structures have been suitably updated.</p>
<h3 class="fn"><a name="client"></a><a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a> * QxtAbstractConnectionManager::client ( <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>clientID</i> ) const</h3>
<p>Returns the <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a> for the requested <i>clientID</i>.</p>
<h3 class="fn"><a name="clientCount"></a>int QxtAbstractConnectionManager::clientCount () const</h3>
<p>Returns the number of connected clients.</p>
<h3 class="fn"><a name="clients"></a><a href="http://doc.qtsoftware.com/4.5/qlist.html">QList</a><<a href="http://doc.qtsoftware.com/4.5/qtglobal.html#quint64-typedef">quint64</a>> QxtAbstractConnectionManager::clients () const</h3>
<p>Returns a list of client IDs for all connected clients.</p>
<h3 class="fn"><a name="disconnect"></a>void QxtAbstractConnectionManager::disconnect ( <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>clientID</i> ) <tt> [slot]</tt></h3>
<p>Disconnects the connection with the specified <i>clientID</i>.</p>
<p>Implementations should invoke this function when the connection should no longer be used; for instance, when the <a href="http://doc.qtsoftware.com/4.5/qiodevice.html">QIODevice</a> object is destroyed or the connection has been closed. Code that uses the connection manager service should invoke this function to close a connection on demand.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
