QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() method. More...

#include <qgsserverresponse.h>

Inheritance diagram for QgsServerResponse:

[legend]

Public Member Functions
	QgsServerResponse ()=default
	constructor More...

virtual	~QgsServerResponse ()=default
	destructor More...

virtual void	clear ()=0
	Reset all headers and content for this response. More...

virtual QByteArray	data () const =0
	Gets the data written so far. More...

virtual void	finish () SIP_THROW(QgsServerException)
	Finish the response, ending the transaction. More...

virtual void	flush () SIP_THROW(QgsServerException)
	Flushes the current output buffer to the network. More...

virtual QString	header (const QString &key) const =0
	Returns the header value. More...

virtual QMap< QString, QString >	headers () const =0
	Returns the header value. More...

virtual bool	headersSent () const =0
	Returns `true` if the headers have already been sent. More...

virtual QIODevice *	io ()=0
	Returns the underlying QIODevice. More...

virtual void	removeHeader (const QString &key)=0
	Clear header Undo a previous 'setHeader' call. More...

virtual void	sendError (int code, const QString &message)=0
	Send error This method delegates error handling at the server level. More...

virtual void	setHeader (const QString &key, const QString &value)=0
	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...

virtual void	setStatusCode (int code)=0
	Set the http status code. More...

virtual int	statusCode () const =0
	Returns the http status code. More...

virtual void	truncate ()=0
	Truncate data. 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

QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() method.

Since: QGIS 3.0

Definition at line 43 of file qgsserverresponse.h.

Constructor & Destructor Documentation

◆ QgsServerResponse()

QgsServerResponse::QgsServerResponse ( )

default

constructor

◆ ~QgsServerResponse()

virtual QgsServerResponse::~QgsServerResponse ( )

virtualdefault

destructor

Member Function Documentation

◆ clear()

virtual void QgsServerResponse::clear ( )

pure virtual

Reset all headers and content for this response.

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ data()

virtual QByteArray QgsServerResponse::data ( ) const

pure virtual

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

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ finish()

void QgsServerResponse::finish ( )

virtual

Finish the response, ending the transaction.

The default implementation does nothing.

Reimplemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

Definition at line 68 of file qgsserverresponse.cpp.

◆ flush()

void QgsServerResponse::flush ( )

virtual

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()'. The default implementation does nothing.

Reimplemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

Definition at line 73 of file qgsserverresponse.cpp.

◆ header()

virtual QString QgsServerResponse::header ( const QString & key ) const

pure virtual

Returns the header value.

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ headers()

virtual QMap<QString, QString> QgsServerResponse::headers ( ) const

pure virtual

Returns the header value.

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ headersSent()

virtual bool QgsServerResponse::headersSent ( ) const

pure virtual

Returns true if the headers have already been sent.

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ io()

virtual QIODevice* QgsServerResponse::io ( )

pure virtual

Returns the underlying QIODevice.

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ removeHeader()

virtual void QgsServerResponse::removeHeader ( const QString & key )

pure virtual

Clear header Undo a previous 'setHeader' call.

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ sendError()

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

pure virtual

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

code	HHTP return code value
message	An informative error message

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ setHeader()

virtual void QgsServerResponse::setHeader	(	const QString &	key,
		const QString &	value
	)

pure virtual

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.

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ setStatusCode()

virtual void QgsServerResponse::setStatusCode ( int code )

pure virtual

Set the http status code.

Parameters

code	HTTP status code value

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ statusCode()

virtual int QgsServerResponse::statusCode ( ) const

pure virtual

Returns the http status code.

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ truncate()

virtual void QgsServerResponse::truncate ( )

pure virtual

Truncate data.

Clear internal buffer

Implemented in QgsFilterResponseDecorator, QgsFcgiServerResponse, and QgsBufferServerResponse.

◆ write() [1/6]

qint64 QgsServerResponse::write ( const char * data )

virtual

Writes at most maxSize bytes of data.

This is a convenient method that will write directly to the underlying I/O device

Returns: the number of bytes written

Note: not available in Python bindings

Definition at line 58 of file qgsserverresponse.cpp.

◆ write() [2/6]

qint64 QgsServerResponse::write	(	const char *	data,
		qint64	maxsize
	)

virtual

Writes at most maxSize bytes of data.

This is a convenient method that will write directly to the underlying I/O device

Returns: the number of bytes written

Note: not available in Python bindings

Definition at line 48 of file qgsserverresponse.cpp.

◆ write() [3/6]

qint64 QgsServerResponse::write ( const QByteArray & byteArray )

virtual

Write chunk of data This is a convenient method that will write directly to the underlying I/O device.

Returns: the number of bytes that were actually written

Definition at line 38 of file qgsserverresponse.cpp.

◆ write() [4/6]

void QgsServerResponse::write ( const QgsServerException & ex )

virtual

Write server exception.

Definition at line 83 of file qgsserverresponse.cpp.

◆ write() [5/6]

void QgsServerResponse::write ( const QString & data )

virtual

Write string This is a convenient method that will write directly to the underlying I/O device.

Definition at line 25 of file qgsserverresponse.cpp.

◆ write() [6/6]

qint64 QgsServerResponse::write ( std::string data )

virtual

Writes at most maxSize bytes of data.

This is a convenient method that will write directly to the underlying I/O device

Returns: the number of bytes written

Note: not available in Python bindings

Since: QGIS 3.10

Definition at line 78 of file qgsserverresponse.cpp.

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

/build/qgis-3.18.1+99unstable/src/server/qgsserverresponse.h
/build/qgis-3.18.1+99unstable/src/server/qgsserverresponse.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsServerResponse()

◆ ~QgsServerResponse()

Member Function Documentation

◆ clear()

◆ data()

◆ finish()

◆ flush()

◆ header()

◆ headers()

◆ headersSent()

◆ io()

◆ removeHeader()

◆ sendError()

◆ setHeader()

◆ setStatusCode()

◆ statusCode()

◆ truncate()

◆ write() [1/6]

◆ write() [2/6]

◆ write() [3/6]

◆ write() [4/6]

◆ write() [5/6]

◆ write() [6/6]