QHttpServerResponder Class

Member Function Documentation

[default] QHttpServerResponder::QHttpServerResponder(QHttpServerResponder &&other)

Move-constructs a QHttpServerResponder instance, making it point at the same object that other was pointing to.

[since 6.11] class Q_DECL_IMPORT QHttpServerResponder::isResponseCanceled() const

Returns true if the client has canceled the response. Used to make it possible to exit early in handler when the response is canceled.

This function was introduced in Qt 6.11.

[since 6.5] class Q_DECL_IMPORT QHttpServerResponder::sendResponse(const QHttpServerResponse &response)

Sends a HTTP response to the client.

This function was introduced in Qt 6.5.

[noexcept, since 6.8] void QHttpServerResponder::swap(QHttpServerResponder &other)

Swaps QHttpServerResponder other with this QHttpServerResponder. This operation is very fast and never fails.

This function was introduced in Qt 6.8.

class Q_DECL_IMPORT QHttpServerResponder::write(QHttpServerResponder::StatusCode status = StatusCode::Ok)

Answers a request with an HTTP status code status.

Note: This function sets HTTP Content-Type header as "application/x-empty".

class Q_DECL_IMPORT QHttpServerResponder::write(const QHttpHeaders &headers, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Answers a request with an HTTP status code status and HTTP Headers headers.

class Q_DECL_IMPORT QHttpServerResponder::write(const int &document, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Answers a request with an HTTP status code status, and JSON document document.

Note: This function sets HTTP Content-Type header as "application/json".

class Q_DECL_IMPORT QHttpServerResponder::write(const int &data, const QHttpHeaders &headers, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Answers a request with an HTTP status code status, HTTP Headers headers and a body data.

Note: This function sets HTTP Content-Length header.

class Q_DECL_IMPORT QHttpServerResponder::write(const int &data, const int &mimeType, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Answers a request with an HTTP status code status, a MIME type mimeType and a body data.

class Q_DECL_IMPORT QHttpServerResponder::write(int *data, const QHttpHeaders &headers, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Answers a request with an HTTP status code status and HTTP headers headers. The I/O device data provides the body of the response. If data is sequential, the body of the message is sent in chunks: otherwise, the function assumes all the content is available and sends it all at once but the read is done in chunks.

class Q_DECL_IMPORT QHttpServerResponder::write(int *data, const int &mimeType, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Answers a request with an HTTP status code status and a MIME type mimeType. The I/O device data provides the body of the response. If data is sequential, the body of the message is sent in chunks: otherwise, the function assumes all the content is available and sends it all at once but the read is done in chunks.

[since 6.8] class Q_DECL_IMPORT QHttpServerResponder::writeBeginChunked(const QHttpHeaders &headers, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Start sending chunks of data with headers and and the status code status. This call must be followed up with an arbitrary number of repeated writeChunk calls and and a single call to writeEndChunked.

This function was introduced in Qt 6.8.

See also writeChunk and writeEndChunked.

[since 6.8] class Q_DECL_IMPORT QHttpServerResponder::writeBeginChunked(const int &mimeType, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Start sending chunks of data with the mime type mimeType and and the given status code status. This call must be followed up with an arbitrary number of repeated writeChunk calls and and a single call to writeEndChunked.

This function was introduced in Qt 6.8.

See also writeChunk and writeEndChunked.

[since 6.8] class Q_DECL_IMPORT QHttpServerResponder::writeBeginChunked(const QHttpHeaders &headers, int trailers, QHttpServerResponder::StatusCode status = StatusCode::Ok)

Start sending chunks of data with headers and and the given status code status. This call must be followed up with an arbitrary number of repeated writeChunk calls and and a single call to writeEndChunked with the same trailers given in trailers.

This function was introduced in Qt 6.8.

See also writeChunk and writeEndChunked.

[since 6.8] class Q_DECL_IMPORT QHttpServerResponder::writeChunk(const int &data)

Write data back to the client. To be called when data is available to write. This can be called multiple times, but before calling this writeBeginChunked must called, and afterwards writeEndChunked must be called.

This function was introduced in Qt 6.8.

See also writeBeginChunked and writeEndChunked.

[since 6.8] class Q_DECL_IMPORT QHttpServerResponder::writeEndChunked(const int &data)

Write data back to the client. Must be preceded by a call to writeBeginChunked.

This function was introduced in Qt 6.8.

See also writeBeginChunked and writeChunk.

[since 6.8] class Q_DECL_IMPORT QHttpServerResponder::writeEndChunked(const int &data, const QHttpHeaders &trailers)

Write data back to the client with the trailers announced in writeBeginChunked.

This function was introduced in Qt 6.8.

See also writeBeginChunked and writeChunk.