summaryrefslogtreecommitdiffstats
path: root/python/pyqt/sip/qtnetwork/qhttp.sip
blob: fbcc99998677e2b088b73bfa4e0b2582fba68970 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
// This is the SIP interface definition for QHttp, QHttpHeader,
// QHttpRequestHeader and QHttpResponseHeader.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyQt.
// 
// This copy of PyQt is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2, or (at your option) any later
// version.
// 
// PyQt is supplied in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
// 
// You should have received a copy of the GNU General Public License along with
// PyQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 
%ExportedDoc
<Sect2><Title>QHttp (Qt v3+)</Title>
<FuncSynopsis>
        <FuncDef>Q_LONG <Function>readBlock</Function></FuncDef>
        <ParamDef>char *<Parameter>data</Parameter></ParamDef>
        <ParamDef>Q_ULONG <Parameter>maxlen</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes a single <Literal>maxlen</Literal> parameter.  The
<Literal>data</Literal> is returned if there was no error, otherwise
<Literal>None</Literal> is returned.
</Para>
</Sect2>

<Sect2><Title>QHttpHeader (Qt v3.1+)</Title>
<Para>
<Literal>QHttpHeader</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QHttpRequestHeader (Qt v3.1+)</Title>
<Para>
<Literal>QHttpRequestHeader</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QHttpResponseHeader (Qt v3.1+)</Title>
<Para>
<Literal>QHttpResponseHeader</Literal> is fully implemented.
</Para>
</Sect2>
%End


%If (Qt_NETWORKPROTOCOL_HTTP)
%If (Qt_3_1_0 -)

class QHttpHeader
{
%TypeHeaderCode
#include <qhttp.h>
%End

public:
	QHttpHeader();
	QHttpHeader(const QHttpHeader &);
	QHttpHeader(const QString &);
	virtual ~QHttpHeader();

	QString value(const QString &) const;
	void setValue(const QString &,const QString &);
	void removeValue(const QString &);

	QStringList keys() const;
	bool hasKey(const QString &) const;

	bool hasContentLength() const;
	uint contentLength() const;
	void setContentLength(int);

	bool hasContentType() const;
	QString contentType() const;
	void setContentType(const QString &);

	virtual QString toString() const;
	bool isValid() const;

	virtual int majorVersion() const = 0;
	virtual int minorVersion() const = 0;

protected:
	virtual bool parseLine(const QString &,int);
	bool parse(const QString &);
	void setValid(bool);
};


class QHttpResponseHeader : QHttpHeader
{
%TypeHeaderCode
#include <qhttp.h>
%End

public:
	QHttpResponseHeader();
	QHttpResponseHeader(const QHttpResponseHeader &);

	int statusCode() const;
	QString reasonPhrase() const;

	int majorVersion() const;
	int minorVersion() const;

	QString toString() const;

protected:
	bool parseLine(const QString &,int);
};


class QHttpRequestHeader : QHttpHeader
{
%TypeHeaderCode
#include <qhttp.h>
%End

public:
	QHttpRequestHeader();
	QHttpRequestHeader(const QString &,const QString &,int = 1,int = 1);
	QHttpRequestHeader(const QHttpRequestHeader &);
	QHttpRequestHeader(const QString &);

	void setRequest(const QString &,const QString &,int = 1,int = 1);

	QString method() const;
	QString path() const;

	int majorVersion() const;
	int minorVersion() const;

	QString toString() const;

protected:
	bool parseLine(const QString &,int);
};

%End


%If (Qt_3_0_0 -)

class QHttp : QNetworkProtocol
{
%TypeHeaderCode
#include <qhttp.h>
%End

public:
	QHttp();
%If (Qt_3_1_0 -)
	QHttp(QObject * /TransferThis/,const char * = 0);
	QHttp(const QString &,Q_UINT16 = 80,QObject * /TransferThis/ = 0,
	      const char * = 0);
	virtual ~QHttp();
%End

	int supportedOperations() const;

%If (Qt_3_1_0 -)
	enum State {
		Unconnected,
		HostLookup,
		Connecting,
		Sending,
		Reading,
		Connected,
		Closing
	};

	enum Error {
		NoError,
		UnknownError,
		HostNotFound,
		ConnectionRefused,
		UnexpectedClose,
		InvalidResponseHeader,
		WrongContentLength,
		Aborted
	};

	int setHost(const QString &,Q_UINT16 = 80);

	int get(const QString &,QIODevice * = 0) /ReleaseGIL/;
	int post(const QString &,QIODevice *,QIODevice * = 0) /ReleaseGIL/;
	int post(const QString &,const QByteArray &,
		 QIODevice * = 0) /ReleaseGIL/;
	int head(const QString &) /ReleaseGIL/;
	int request(const QHttpRequestHeader &,QIODevice * = 0,
		    QIODevice * = 0) /ReleaseGIL/;
	int request(const QHttpRequestHeader &,const QByteArray &,
		    QIODevice * = 0) /ReleaseGIL/;

	int closeConnection();

	unsigned long bytesAvailable() const;

	SIP_PYOBJECT readBlock(Q_ULONG) /ReleaseGIL/ [Q_LONG (char *,Q_ULONG)];
%MethodCode
		char *buf;

		if ((buf = (char *)sipMalloc(a0)) == NULL)
			sipIsErr = 1;
		else
		{
			Q_LONG actlen;

			Py_BEGIN_ALLOW_THREADS
			actlen = sipCpp -> QHttp::readBlock(buf,a0);
			Py_END_ALLOW_THREADS

			if (actlen < 0)
			{
				Py_INCREF(Py_None);
				sipRes = Py_None;
			}
			else if ((sipRes = PyString_FromStringAndSize(buf,actlen)) == NULL)
				sipIsErr = 1;

			sipFree((ANY *)buf);
		}
%End

	QByteArray readAll() /ReleaseGIL/;

	int currentId() const;
	QIODevice *currentSourceDevice() const;
	QIODevice *currentDestinationDevice() const;
	QHttpRequestHeader currentRequest() const;
	bool hasPendingRequests() const;
	void clearPendingRequests();

	State state() const;

	Error error() const;
	QString errorString() const;
%End

public slots:
%If (Qt_3_1_0 -)
	void abort();
%End

signals:
%If (Qt_3_1_0 -)
	void stateChanged(int);
	void responseHeaderReceived(const QHttpResponseHeader &);
	void readyRead(const QHttpResponseHeader &);
	void dataSendProgress(int,int);
	void dataReadProgress(int,int);

	void requestStarted(int);
	void requestFinished(int,bool);
	void done(bool);
%End

protected:
	void operationGet(QNetworkOperation *);
	void operationPut(QNetworkOperation *);

%If (Qt_3_1_0 -)
	void timerEvent(QTimerEvent *);
%End
};

%End
%End