Defines fcgi responses. More...

#include <qgsfcgiserverresponse.h>

Inheritance diagram for QgsFcgiServerResponse:

Public Member Functions
	QgsFcgiServerResponse (QgsServerRequest::Method method=QgsServerRequest::GetMethod)
	Constructor for QgsFcgiServerResponse.
	~QgsFcgiServerResponse () override
void	addHeader (const QString &key, const QString &value) override
	Add a header value for the given key, without replacing any existing value for the same key Add Header entry to the response.
void	clear () override
	Reset all headers and content for this response.
QByteArray	data () const override
	Gets the data written so far.
QgsFeedback *	feedback () const override
	Returns socket feedback if any.
void	finish () override
	Finish the response, ending the transaction.
void	flush () override
	Flushes the current output buffer to the network.
QList< QString >	fullHeader (const QString &key) const override
	Returns a (possibly empty) list of all the header values for the given key.
QMap< QString, QList< QString > >	fullHeaders () const override
	Returns all the header values.
QString	header (const QString &key) const override
	Returns a single header value for a given key.
QMap< QString, QString >	headers () const override
	Returns the header values as a map: only the last value is returned if multiple values are set for the same header.
bool	headersSent () const override
	Returns `true` if the headers have already been sent.
QIODevice *	io () override
	Returns the underlying QIODevice.
void	removeHeader (const QString &key) override
	Clear all header values for the given key Undo a previous 'setHeader' call.
void	sendError (int code, const QString &message) override
	Send error This method delegates error handling at the server level.
void	setDefaultHeaders ()
	Set the default headers.
void	setHeader (const QString &key, const QString &value) override
	Set a single header value replacing any existing value(s) for the same key.
void	setStatusCode (int code) override
	Set the http status code.
int	statusCode () const override
	Returns the http status code.
void	truncate () override
	Truncate data.
Public Member Functions inherited from QgsServerResponse
	QgsServerResponse ()=default
virtual	~QgsServerResponse ()=default
virtual qint64	write (const char *data)
	Writes at most maxSize bytes of data.
virtual qint64	write (const char *data, qint64 maxsize)
	Writes at most maxSize bytes of data.
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.
virtual void	write (const QgsServerException &ex)
	Write server exception.
virtual void	write (const QString &data)
	Write string This is a convenient method that will write directly to the underlying I/O device.
virtual qint64	write (std::string data)
	Writes at most maxSize bytes of data.

Detailed Description

Defines fcgi responses.

Definition at line 72 of file qgsfcgiserverresponse.h.

Constructor & Destructor Documentation

◆ QgsFcgiServerResponse()

QgsFcgiServerResponse::QgsFcgiServerResponse ( QgsServerRequest::Method method = QgsServerRequest::GetMethod )

Constructor for QgsFcgiServerResponse.

Parameters

method The HTTP method (Get by default)

Definition at line 213 of file qgsfcgiserverresponse.cpp.

◆ ~QgsFcgiServerResponse()

QgsFcgiServerResponse::~QgsFcgiServerResponse ( )

override

Definition at line 226 of file qgsfcgiserverresponse.cpp.

Member Function Documentation

◆ addHeader()

void QgsFcgiServerResponse::addHeader	(	const QString &	key,
		const QString &	value )

overridevirtual

Add a header value for the given key, without replacing any existing value for the same key Add Header entry to the response.

Note: that it is usually an error to set Header after data have been sent through the wire

See also: setHeader() for a method that replaces any existing value(s) for the same header key

Since: QGIS 4.2

Implements QgsServerResponse.

Definition at line 242 of file qgsfcgiserverresponse.cpp.

◆ clear()

void QgsFcgiServerResponse::clear ( )

overridevirtual

Reset all headers and content for this response.

Implements QgsServerResponse.

Definition at line 384 of file qgsfcgiserverresponse.cpp.

◆ data()

QByteArray QgsFcgiServerResponse::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 392 of file qgsfcgiserverresponse.cpp.

◆ feedback()

QgsFeedback * QgsFcgiServerResponse::feedback ( ) const

inlineoverridevirtual

Returns socket feedback if any.

Since: QGIS 3.36

Reimplemented from QgsServerResponse.

Definition at line 124 of file qgsfcgiserverresponse.h.

◆ finish()

void QgsFcgiServerResponse::finish ( )

overridevirtual

Finish the response, ending the transaction.

The default implementation does nothing.

Reimplemented from QgsServerResponse.

Definition at line 315 of file qgsfcgiserverresponse.cpp.

◆ flush()

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

Reimplemented from QgsServerResponse.

Definition at line 342 of file qgsfcgiserverresponse.cpp.

◆ fullHeader()

QList< QString > QgsFcgiServerResponse::fullHeader ( const QString & key ) const

overridevirtual

Returns a (possibly empty) list of all the header values for the given key.

See also: header() to get only the last value for a given header key

Since: QGIS 4.2

Implements QgsServerResponse.

Definition at line 276 of file qgsfcgiserverresponse.cpp.

◆ fullHeaders()

QMap< QString, QList< QString > > QgsFcgiServerResponse::fullHeaders ( ) const

inlineoverridevirtual

Returns all the header values.

See also: headers() to get only the last value for each header key

Since: QGIS 4.2

Implements QgsServerResponse.

Definition at line 93 of file qgsfcgiserverresponse.h.

◆ header()

QString QgsFcgiServerResponse::header ( const QString & key ) const

overridevirtual

Returns a single header value for a given key.

Note: if multiple values are set for the same key, the last one is returned

Deprecated: QGIS 4.2. Use fullHeader() instead.

Implements QgsServerResponse.

Definition at line 260 of file qgsfcgiserverresponse.cpp.

◆ headers()

QMap< QString, QString > QgsFcgiServerResponse::headers ( ) const

overridevirtual

Returns the header values as a map: only the last value is returned if multiple values are set for the same header.

See also: fullHeaders() to get all the values for all the headers

Deprecated: QGIS 4.2. Use fullHeaders() instead.

Implements QgsServerResponse.

Definition at line 266 of file qgsfcgiserverresponse.cpp.

◆ headersSent()

bool QgsFcgiServerResponse::headersSent ( ) const

overridevirtual

Returns true if the headers have already been sent.

Implements QgsServerResponse.

Definition at line 281 of file qgsfcgiserverresponse.cpp.

◆ io()

QIODevice * QgsFcgiServerResponse::io ( )

overridevirtual

Returns the underlying QIODevice.

Implements QgsServerResponse.

Definition at line 310 of file qgsfcgiserverresponse.cpp.

◆ removeHeader()

void QgsFcgiServerResponse::removeHeader ( const QString & key )

overridevirtual

Clear all header values for the given key Undo a previous 'setHeader' call.

Implements QgsServerResponse.

Definition at line 237 of file qgsfcgiserverresponse.cpp.

◆ sendError()

void QgsFcgiServerResponse::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

code	HHTP return code value
message	An informative error message

Implements QgsServerResponse.

Definition at line 295 of file qgsfcgiserverresponse.cpp.

◆ setDefaultHeaders()

void QgsFcgiServerResponse::setDefaultHeaders ( )

Set the default headers.

Definition at line 405 of file qgsfcgiserverresponse.cpp.

◆ setHeader()

void QgsFcgiServerResponse::setHeader	(	const QString &	key,
		const QString &	value )

overridevirtual

Set a single header value replacing any existing value(s) for the same key.

Note: that it is usually an error to set Header after data have been sent through the wire

See also: addHeader() for a method that allows setting multiple values for the same header key; removeHeader() to clear header values for a given key

Implements QgsServerResponse.

Definition at line 255 of file qgsfcgiserverresponse.cpp.

◆ setStatusCode()

void QgsFcgiServerResponse::setStatusCode ( int code )

overridevirtual

Set the http status code.

Parameters

code	HTTP status code value

Implements QgsServerResponse.

Definition at line 286 of file qgsfcgiserverresponse.cpp.

◆ statusCode()

int QgsFcgiServerResponse::statusCode ( ) const

inlineoverridevirtual

Returns the http status code.

Implements QgsServerResponse.

Definition at line 99 of file qgsfcgiserverresponse.h.

◆ truncate()

void QgsFcgiServerResponse::truncate ( )

overridevirtual

Truncate data.

Clear internal buffer

Implements QgsServerResponse.

Definition at line 398 of file qgsfcgiserverresponse.cpp.

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

/build/qgis-4.1.0+git20260529+31622b25bb0+99sid/src/server/qgsfcgiserverresponse.h
/build/qgis-4.1.0+git20260529+31622b25bb0+99sid/src/server/qgsfcgiserverresponse.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsFcgiServerResponse()

◆ ~QgsFcgiServerResponse()

Member Function Documentation

◆ addHeader()

◆ clear()

◆ data()

◆ feedback()

◆ finish()

◆ flush()

◆ fullHeader()

◆ fullHeaders()

◆ header()

◆ headers()

◆ headersSent()

◆ io()

◆ removeHeader()

◆ sendError()

◆ setDefaultHeaders()

◆ setHeader()

◆ setStatusCode()

◆ statusCode()

◆ truncate()