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

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="namespaces.html"><font color="#004faf">All Namespaces</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</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">QSocketNotifier Class Reference<br /><span class="small-subtitle">[<a href="qtcore.html">QtCore</a> module]</span>

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>

</tr></table><h1 class="title">QSocketNotifier Class Reference<br /><span class="small-subtitle">[<a href="qtcore.html">QtCore</a> module]</span>

</h1>

<p>The QSocketNotifier class provides support for monitoring activity on a file descriptor. <a href="#details">More...</a></p>

<pre> #include <QSocketNotifier></pre><p>Inherits <a href="qobject.html">QObject</a>.</p>

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

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

</ul>

<hr />

<h3>Public Types</h3>

<ul>

<li><div class="fn"></div>enum <b><a href="qsocketnotifier.html#Type-enum">Type</a></b> { Read, Write, Exception }</li>

</ul>

<h2>Public Types</h2>

<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#Type-enum">Type</a></b> { Read, Write, Exception }</td></tr>

</table>

<hr />

<h3>Public Functions</h3>

<ul>

<li><div class="fn"></div><b><a href="qsocketnotifier.html#QSocketNotifier">QSocketNotifier</a></b> ( int <i>socket</i>, Type <i>type</i>, QObject * <i>parent</i> = 0 )</li>

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

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

<li><div class="fn"></div>int <b><a href="qsocketnotifier.html#socket">socket</a></b> () const</li>

<li><div class="fn"></div>Type <b><a href="qsocketnotifier.html#type">type</a></b> () const</li>

</ul>

<ul>

<li><div class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

</ul>

<h2>Public Functions</h2>

<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#QSocketNotifier">QSocketNotifier</a></b> ( int <i>socket</i>, Type <i>type</i>, QObject * <i>parent</i> = 0 )</td></tr>

<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#dtor.QSocketNotifier">~QSocketNotifier</a></b> ()</td></tr>

<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#isEnabled">isEnabled</a></b> () const</td></tr>

<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#socket">socket</a></b> () const</td></tr>

<tr><td class="memItemLeft" align="right" valign="top">Type </td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#type">type</a></b> () const</td></tr>

</table>

<ul>

<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

</ul>

<hr />

<h3>Public Slots</h3>

<ul>

<li><div class="fn"></div>void <b><a href="qsocketnotifier.html#setEnabled">setEnabled</a></b> ( bool <i>enable</i> )</li>

</ul>

<ul>

<li><div class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

</ul>

<h2>Public Slots</h2>

<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#setEnabled">setEnabled</a></b> ( bool <i>enable</i> )</td></tr>

</table>

<ul>

<li><div bar="2" class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

</ul>

<hr />

<h3>Signals</h3>

<h2>Signals</h2>

<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#activated">activated</a></b> ( int <i>socket</i> )</td></tr>

</table>

<ul>

<li><div class="fn"></div>void <b><a href="qsocketnotifier.html#activated">activated</a></b> ( int <i>socket</i> )</li>

<li><div bar="2" class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

</ul>

<hr />

<h2>Reimplemented Protected Functions</h2>

<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qsocketnotifier.html#event">event</a></b> ( QEvent * <i>e</i> )</td></tr>

</table>

<ul>

<li><div class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

<li><div bar="2" class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<hr />

<h2>Detailed Description</h2>

<p>The QSocketNotifier class provides support for monitoring activity on a file descriptor.</p>

<p>The QSocketNotifier makes it possible to integrate Qt's event loop with other event loops based on file descriptors. For example, the <a href="http://www.qtsoftware.com/products/add-on-products/catalog/4/Utilities/qtcorba/">CORBA Framework</a> uses it to process CORBA events. File descriptor action is detected in Qt's main event loop (<a href="qcoreapplication.html#exec">QCoreApplication::exec</a>()).</p>

<p>The QSocketNotifier makes it possible to integrate Qt's event loop with other event loops based on file descriptors. For example, the <a href="http://qt.nokia.com/products/add-on-products/catalog/4/Utilities/qtcorba/">CORBA Framework</a> uses it to process CORBA events. File descriptor action is detected in Qt's main event loop (<a href="qcoreapplication.html#exec">QCoreApplication::exec</a>()).</p>

<a name="write-notifiers"></a><p>Once you have opened a device using a low-level (usually platform-specific) API, you can create a socket notifier to monitor the file descriptor. The socket notifier is enabled by default, i.e. it emits the <a href="qsocketnotifier.html#activated">activated</a>() signal whenever a socket event corresponding to its type occurs. Connect the <a href="qsocketnotifier.html#activated">activated</a>() signal to the slot you want to be called when an event corresponding to your socket notifier's type occurs.</p>

<p>There are three types of socket notifiers: read, write, and exception. The type is described by the <a href="qsocketnotifier.html#Type-enum">Type</a> enum, and must be specified when constructing the socket notifier. After construction it can be determined using the <a href="qsocketnotifier.html#type">type</a>() function. Note that if you need to monitor both reads and writes for the same file descriptor, you must create two socket notifiers. Note also that it is not possible to install two socket notifiers of the same type (<a href="qsocketnotifier.html#Type-enum">Read</a>, <a href="qsocketnotifier.html#Type-enum">Write</a>, <a href="qsocketnotifier.html#Type-enum">Exception</a>) on the same socket.</p>

<p>The <a href="qsocketnotifier.html#setEnabled">setEnabled</a>() function allows you to disable as well as enable the socket notifier. It is generally advisable to explicitly enable or disable the socket notifier, especially for write notifiers. A disabled notifier ignores socket events (the same effect as not creating the socket notifier). Use the <a href="qsocketnotifier.html#isEnabled">isEnabled</a>() function to determine the notifier's current status.</p>

101

<p>See also <a href="qfile.html">QFile</a>, <a href="qprocess.html">QProcess</a>, <a href="qtcpsocket.html">QTcpSocket</a>, and <a href="qudpsocket.html">QUdpSocket</a>.</p>

102

<hr />

103

<h2>Member Type Documentation</h2>

104

105

106

107

108

<h3 class="fn"><a name="Type-enum"></a>enum QSocketNotifier::Type</h3>

109

<p>This enum describes the various types of events that a socket notifier can recognize. The type must be specified when constructing the socket notifier.</p>

110

<p>Note that if you need to monitor both reads and writes for the same file descriptor, you must create two socket notifiers. Note also that it is not possible to install two socket notifiers of the same type (Read, Write, Exception) on the same socket.</p>

111

112

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

113

<tr><td valign="top"><tt>QSocketNotifier::Read</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">There is data to be read.</td></tr>

114

<tr><td valign="top"><tt>QSocketNotifier::Write</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">Data can be written.</td></tr>

117

<p>See also <a href="qsocketnotifier.html#QSocketNotifier">QSocketNotifier</a>() and <a href="qsocketnotifier.html#type">type</a>().</p>

100

118

<hr />

101

119

<h2>Member Function Documentation</h2>

120

102

121

<h3 class="fn"><a name="QSocketNotifier"></a>QSocketNotifier::QSocketNotifier ( int <i>socket</i>, <a href="qsocketnotifier.html#Type-enum">Type</a> <i>type</i>, <a href="qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>

103

122

<p>Constructs a socket notifier with the given <i>parent</i>. It enables the <i>socket</i>, and watches for events of the given <i>type</i>.</p>

104

123

<p>It is generally advisable to explicitly enable or disable the socket notifier, especially for write notifiers.</p>

105

124

<p><b>Note for Windows users:</b> The socket passed to <a href="qsocketnotifier.html">QSocketNotifier</a> will become non-blocking, even if it was created as a blocking socket.</p>

106

125

<p>See also <a href="qsocketnotifier.html#setEnabled">setEnabled</a>() and <a href="qsocketnotifier.html#isEnabled">isEnabled</a>().</p>

126

107

127

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

108

128

<p>Destroys this socket notifier.</p>

129

109

130

<h3 class="fn"><a name="activated"></a>void QSocketNotifier::activated ( int <i>socket</i> )  <tt> [signal]</tt></h3>

110

131

<p>This signal is emitted whenever the socket notifier is enabled and a socket event corresponding to its <a href="qsocketnotifier.html#Type-enum">type</a> occurs.</p>

111

132

<p>The socket identifier is passed in the <i>socket</i> parameter.</p>

112

133

<p>See also <a href="qsocketnotifier.html#type">type</a>() and <a href="qsocketnotifier.html#socket">socket</a>().</p>

134

135

<h3 class="fn"><a name="event"></a>bool QSocketNotifier::event ( <a href="qevent.html">QEvent</a> * <i>e</i> )  <tt> [virtual protected]</tt></h3>

136

<p>Reimplemented from <a href="qobject.html#event">QObject::event</a>().</p>

137

113

138

<h3 class="fn"><a name="isEnabled"></a>bool QSocketNotifier::isEnabled () const</h3>

114

139

<p>Returns true if the notifier is enabled; otherwise returns false.</p>

115

140

<p>See also <a href="qsocketnotifier.html#setEnabled">setEnabled</a>().</p>

141

116

142

<h3 class="fn"><a name="setEnabled"></a>void QSocketNotifier::setEnabled ( bool <i>enable</i> )  <tt> [slot]</tt></h3>

117

143

<p>If <i>enable</i> is true, the notifier is enabled; otherwise the notifier is disabled.</p>

118

144

<p>The notifier is enabled by default, i.e. it emits the <a href="qsocketnotifier.html#activated">activated</a>() signal whenever a socket event corresponding to its <a href="qsocketnotifier.html#type">type</a> occurs. If it is disabled, it ignores socket events (the same effect as not creating the socket notifier).</p>

119

145

<p>Write notifiers should normally be disabled immediately after the <a href="qsocketnotifier.html#activated">activated</a>() signal has been emitted</p>

120

146

<p>See also <a href="qsocketnotifier.html#isEnabled">isEnabled</a>() and <a href="qsocketnotifier.html#activated">activated</a>().</p>

147

121

148

<h3 class="fn"><a name="socket"></a>int QSocketNotifier::socket () const</h3>

122

149

<p>Returns the socket identifier specified to the constructor.</p>

123

150

151

124

152

<h3 class="fn"><a name="type"></a><a href="qsocketnotifier.html#Type-enum">Type</a> QSocketNotifier::type () const</h3>

125

153

<p>Returns the socket event type specified to the constructor.</p>

126

154

<p>See also <a href="qsocketnotifier.html#socket">socket</a>().</p>

127

155

128

156

129

130

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

131

132

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

157

158

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

159

160

133

161

</html>

Older »