File: qgsbufferserverresponse.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (146 lines) | stat: -rw-r--r-- 3,708 bytes parent folder | download | duplicates (12)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/server/qgsbufferserverresponse.h                                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsBufferServerResponse : QgsServerResponse
{
%Docstring(signature="appended")
Class defining buffered response
%End

%TypeHeaderCode
#include "qgsbufferserverresponse.h"
%End
  public:
    QgsBufferServerResponse();

    virtual void setHeader( const QString &key, const QString &value );

%Docstring
Set Header entry Add Header entry to the response Note that it is
usually an error to set Header after data have been sent through the
wire
%End

    virtual void removeHeader( const QString &key );

%Docstring
Clear header Undo a previous 'setHeader' call
%End

    virtual QString header( const QString &key ) const;

%Docstring
Returns the header value
%End

    virtual QMap<QString, QString> headers() const;
%Docstring
Returns all the headers
%End

    virtual bool headersSent() const;

%Docstring
Returns ``True`` if the headers have already been sent
%End

    virtual void setStatusCode( int code );

%Docstring
Set the http status code

:param code: HTTP status code value
%End

    virtual int statusCode() const;
%Docstring
Returns the http status code
%End

    virtual void sendError( int code, const QString &message );

%Docstring
Send error This method delegates error handling at the server level.
This is different from calling
:py:func:`~QgsBufferServerResponse.setReturnCode` which let you return a
specific response body. Calling
:py:func:`~QgsBufferServerResponse.sendError` will end the transaction
and any attempt to write data or set headers will be an error.

:param code: HHTP return code value
:param message: An informative error message
%End

    virtual QIODevice *io();

%Docstring
Returns the underlying QIODevice
%End

    virtual void finish();

%Docstring
Finish the response, ending the transaction
%End

    virtual void flush();

%Docstring
Flushes the current output buffer to the network

':py:func:`~QgsBufferServerResponse.flush`' may be called multiple
times. For HTTP transactions headers will be written on the first call
to ':py:func:`~QgsBufferServerResponse.flush`'.
%End

    virtual void clear();

%Docstring
Reset all headers and content for this response
%End

    virtual QByteArray data() const;

%Docstring
Gets the data written so far

This is implementation dependent: some implementations may not give
access to the underlying and return an empty array.

Note that each call to 'flush' may empty the buffer and in case of
streaming process you may get partial content
%End

    virtual void truncate();

%Docstring
Truncate data

Clear internal buffer
%End

    QByteArray body() const;
%Docstring
Returns body
%End


  private:
    QgsBufferServerResponse( const QgsBufferServerResponse & );
};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/server/qgsbufferserverresponse.h                                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/