QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | List of all members
QgsBufferServerResponse Class Reference

Class defining buffered response. More...

#include <qgsbufferserverresponse.h>

Inheritance diagram for QgsBufferServerResponse:
Inheritance graph
[legend]

Public Member Functions

 QgsBufferServerResponse ()
 
 QgsBufferServerResponse (const QgsBufferServerResponse &)=delete
 QgsBufferServerResponse cannot be copied. More...
 
QByteArray body () const
 Returns body. More...
 
void clear () override
 Reset all headers and content for this response. More...
 
QByteArray data () const override
 Gets the data written so far. More...
 
void finish () override
 Finish the response, ending the transaction. More...
 
void flush () override
 Flushes the current output buffer to the network. More...
 
QString header (const QString &key) const override
 Returns the header value. More...
 
QMap< QString, QString > headers () const override
 Returns all the headers. More...
 
bool headersSent () const override
 Returns true if the headers have already been sent. More...
 
QIODevice * io () override
 Returns the underlying QIODevice. More...
 
void removeHeader (const QString &key) override
 Clear header Undo a previous 'setHeader' call. More...
 
void sendError (int code, const QString &message) override
 Send error This method delegates error handling at the server level. More...
 
void setHeader (const QString &key, const QString &value) override
 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. More...
 
void setStatusCode (int code) override
 Set the http status code. More...
 
int statusCode () const override
 Returns the http status code. More...
 
void truncate () override
 Truncate data. More...
 
- Public Member Functions inherited from QgsServerResponse
 QgsServerResponse ()=default
 constructor More...
 
virtual ~QgsServerResponse ()=default
 destructor More...
 
virtual qint64 write (const char *data)
 Writes at most maxSize bytes of data. More...
 
virtual qint64 write (const char *data, qint64 maxsize)
 Writes at most maxSize bytes of data. More...
 
virtual qint64 write (const QByteArray &byteArray)
 Write chunk of data This is a convenient method that will write directly to the underlying I/O device. More...
 
virtual void write (const QgsServerException &ex)
 Write server exception. More...
 
virtual void write (const QString &data)
 Write string This is a convenient method that will write directly to the underlying I/O device. More...
 
virtual qint64 write (std::string data)
 Writes at most maxSize bytes of data. More...
 

Detailed Description

Class defining buffered response.

Since
QGIS 3.0

Definition at line 37 of file qgsbufferserverresponse.h.

Constructor & Destructor Documentation

◆ QgsBufferServerResponse() [1/2]

QgsBufferServerResponse::QgsBufferServerResponse ( )

Definition at line 27 of file qgsbufferserverresponse.cpp.

◆ QgsBufferServerResponse() [2/2]

QgsBufferServerResponse::QgsBufferServerResponse ( const QgsBufferServerResponse )
delete

QgsBufferServerResponse cannot be copied.

Member Function Documentation

◆ body()

QByteArray QgsBufferServerResponse::body ( ) const
inline

Returns body.

Definition at line 140 of file qgsbufferserverresponse.h.

◆ clear()

void QgsBufferServerResponse::clear ( )
overridevirtual

Reset all headers and content for this response.

Implements QgsServerResponse.

Definition at line 112 of file qgsbufferserverresponse.cpp.

◆ data()

QByteArray QgsBufferServerResponse::data ( ) const
overridevirtual

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

Implements QgsServerResponse.

Definition at line 120 of file qgsbufferserverresponse.cpp.

◆ finish()

void QgsBufferServerResponse::finish ( )
overridevirtual

Finish the response, ending the transaction.

Reimplemented from QgsServerResponse.

Definition at line 79 of file qgsbufferserverresponse.cpp.

◆ flush()

void QgsBufferServerResponse::flush ( )
overridevirtual

Flushes the current output buffer to the network.

'flush()' may be called multiple times. For HTTP transactions headers will be written on the first call to 'flush()'.

Reimplemented from QgsServerResponse.

Definition at line 98 of file qgsbufferserverresponse.cpp.

◆ header()

QString QgsBufferServerResponse::header ( const QString &  key) const
overridevirtual

Returns the header value.

Implements QgsServerResponse.

Definition at line 49 of file qgsbufferserverresponse.cpp.

◆ headers()

QMap<QString, QString> QgsBufferServerResponse::headers ( ) const
inlineoverridevirtual

Returns all the headers.

Implements QgsServerResponse.

Definition at line 67 of file qgsbufferserverresponse.h.

◆ headersSent()

bool QgsBufferServerResponse::headersSent ( ) const
overridevirtual

Returns true if the headers have already been sent.

Implements QgsServerResponse.

Definition at line 54 of file qgsbufferserverresponse.cpp.

◆ io()

QIODevice * QgsBufferServerResponse::io ( )
overridevirtual

Returns the underlying QIODevice.

Implements QgsServerResponse.

Definition at line 74 of file qgsbufferserverresponse.cpp.

◆ removeHeader()

void QgsBufferServerResponse::removeHeader ( const QString &  key)
overridevirtual

Clear header Undo a previous 'setHeader' call.

Implements QgsServerResponse.

Definition at line 32 of file qgsbufferserverresponse.cpp.

◆ sendError()

void QgsBufferServerResponse::sendError ( int  code,
const QString &  message 
)
overridevirtual

Send error This method delegates error handling at the server level.

This is different from calling setReturnCode() which let you return a specific response body. Calling sendError() will end the transaction and any attempt to write data or set headers will be an error.

Parameters
codeHHTP return code value
messageAn informative error message

Implements QgsServerResponse.

Definition at line 59 of file qgsbufferserverresponse.cpp.

◆ setHeader()

void QgsBufferServerResponse::setHeader ( const QString &  key,
const QString &  value 
)
overridevirtual

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.

Implements QgsServerResponse.

Definition at line 38 of file qgsbufferserverresponse.cpp.

◆ setStatusCode()

void QgsBufferServerResponse::setStatusCode ( int  code)
overridevirtual

Set the http status code.

Parameters
codeHTTP status code value

Implements QgsServerResponse.

Definition at line 44 of file qgsbufferserverresponse.cpp.

◆ statusCode()

int QgsBufferServerResponse::statusCode ( ) const
inlineoverridevirtual

Returns the http status code.

Implements QgsServerResponse.

Definition at line 83 of file qgsbufferserverresponse.h.

◆ truncate()

void QgsBufferServerResponse::truncate ( )
overridevirtual

Truncate data.

Clear internal buffer

Implements QgsServerResponse.

Definition at line 126 of file qgsbufferserverresponse.cpp.


The documentation for this class was generated from the following files: