source: trunk/doc/html/qsocket-h.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 6.1 KB
RevLine 
[190]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/include/qsocket.h:1 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>qsocket.h Include File</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>qsocket.h</h1>
33
34<p>This is the verbatim text of the qsocket.h include file. It is provided only for illustration; the copyright remains with Trolltech.
35<hr>
36<pre>
37/****************************************************************************
38** $Id: qsocket-h.html 2051 2007-02-21 10:04:20Z chehrlic $
39**
40** Definition of QSocket class.
41**
42** Created : 970521
43**
44** Copyright (C) 1992-2007 Trolltech ASA. All rights reserved.
45**
46** This file is part of the network module of the Qt GUI Toolkit.
47**
48** This file may be distributed under the terms of the Q Public License
49** as defined by Trolltech ASA of Norway and appearing in the file
50** LICENSE.QPL included in the packaging of this file.
51**
52** This file may be distributed and/or modified under the terms of the
53** GNU General Public License version 2 as published by the Free Software
54** Foundation and appearing in the file LICENSE.GPL included in the
55** packaging of this file.
56**
57** Licensees holding valid Qt Enterprise Edition licenses may use this
58** file in accordance with the Qt Commercial License Agreement provided
59** with the Software.
60**
61** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
62** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
63**
64** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
65** information about Qt Commercial License Agreements.
66** See http://www.trolltech.com/qpl/ for QPL licensing information.
67** See http://www.trolltech.com/gpl/ for GPL licensing information.
68**
69** Contact info@trolltech.com if any conditions of this licensing are
70** not clear to you.
71**
72**********************************************************************/
73
74#ifndef QSOCKET_H
75#define QSOCKET_H
76
77#ifndef QT_H
78#include "qobject.h"
79#include "qiodevice.h"
80#include "qhostaddress.h" // int-&gt;QHostAddress conversion
81#endif // QT_H
82
83#if !defined( QT_MODULE_NETWORK ) || defined( QT_LICENSE_PROFESSIONAL ) || defined( QT_INTERNAL_NETWORK )
84#define QM_EXPORT_NETWORK
85#else
86#define QM_EXPORT_NETWORK Q_EXPORT
87#endif
88
89#ifndef QT_NO_NETWORK
90class QSocketPrivate;
91class QSocketDevice;
92
93
94class QM_EXPORT_NETWORK QSocket : public QObject, public QIODevice
95{
96 Q_OBJECT
97public:
98 enum Error {
99 ErrConnectionRefused,
100 ErrHostNotFound,
101 ErrSocketRead
102 };
103
104 QSocket( QObject *parent=0, const char *name=0 );
105 virtual ~QSocket();
106
107 enum State { Idle, HostLookup, Connecting,
108 Connected, Closing,
109 Connection=Connected };
110 State state() const;
111
112 int socket() const;
113 virtual void setSocket( int );
114
115 QSocketDevice *socketDevice();
116 virtual void setSocketDevice( QSocketDevice * );
117
118#ifndef QT_NO_DNS
119 virtual void connectToHost( const QString &amp;host, Q_UINT16 port );
120#endif
121 QString peerName() const;
122
123 // Implementation of QIODevice abstract virtual functions
124 bool open( int mode );
125 void close();
126 void flush();
127 Offset size() const;
128 Offset at() const;
129 bool at( Offset );
130 bool atEnd() const;
131
132 Q_ULONG bytesAvailable() const; // ### QIODevice::Offset instead?
133 Q_ULONG waitForMore( int msecs, bool *timeout ) const;
134 Q_ULONG waitForMore( int msecs ) const; // ### Qt 4.0: merge the two overloads
135 Q_ULONG bytesToWrite() const;
136 void clearPendingData();
137
138 Q_LONG readBlock( char *data, Q_ULONG maxlen );
139 Q_LONG writeBlock( const char *data, Q_ULONG len );
140 Q_LONG readLine( char *data, Q_ULONG maxlen );
141
142 int getch();
143 int putch( int );
144 int ungetch(int);
145
146 bool canReadLine() const;
147 virtual QString readLine();
148
149 Q_UINT16 port() const;
150 Q_UINT16 peerPort() const;
151 QHostAddress address() const;
152 QHostAddress peerAddress() const;
153
154 void setReadBufferSize( Q_ULONG );
155 Q_ULONG readBufferSize() const;
156
157signals:
158 void hostFound();
159 void connected();
160 void connectionClosed();
161 void delayedCloseFinished();
162 void readyRead();
163 void bytesWritten( int nbytes );
164 void error( int );
165
166protected slots:
167 virtual void sn_read( bool force=FALSE );
168 virtual void sn_write();
169
170private slots:
171 void tryConnecting();
172 void emitErrorConnectionRefused();
173
174private:
175 QSocketPrivate *d;
176
177 bool consumeWriteBuf( Q_ULONG nbytes );
178 void tryConnection();
179 void setSocketIntern( int socket );
180
181private: // Disabled copy constructor and operator=
182#if defined(Q_DISABLE_COPY)
183 QSocket( const QSocket &amp; );
184 QSocket &amp;operator=( const QSocket &amp; );
185#endif
186};
187
188#endif //QT_NO_NETWORK
189#endif // QSOCKET_H
190</pre>
191<!-- eof -->
192<p><address><hr><div align=center>
193<table width=100% cellspacing=0 border=0><tr>
194<td>Copyright &copy; 2007
195<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
196<td align=right><div align=right>Qt 3.3.8</div>
197</table></div></address></body>
198</html>
Note: See TracBrowser for help on using the repository browser.