This subclass of HTTPResponse is used for representing server-side HTTP responses.
handleRequest() must set a status code and optional reason phrase, set headers as necessary, and provide a message body.
Direct Base Classes: HTTPResponse
Known Derived Classes: HTTPServerResponseImpl
Inherited Functions: add, addCookie, begin, clear, decodeRFC2047, decodeWord, empty, end, erase, find, get, getChunkedTransferEncoding, getContentLength, getContentLength64, getContentType, getCookies, getDate, getFieldLimit, getKeepAlive, getReason, getReasonForStatus, getStatus, getTransferEncoding, getVersion, has, hasContentLength, hasToken, operator =, operator , quote, read, set, setChunkedTransferEncoding, setContentLength, setContentLength64, setContentType, setDate, setFieldLimit, setKeepAlive, setReason, setStatus, setStatusAndReason, setTransferEncoding, setVersion, size, splitElements, splitParameters, swap, write
Creates the HTTPServerResponse.
Destroys the HTTPServerResponse.
virtual void redirect(
const std::string & uri,
HTTPStatus status = HTTP_FOUND
) = 0;
Sets the status code, which must be one of HTTP_MOVED_PERMANENTLY (301), HTTP_FOUND (302), or HTTP_SEE_OTHER (303), and sets the "Location" header field to the given URI, which according to the HTTP specification, must be absolute.
Must not be called after send() has been called.
virtual void requireAuthentication(
const std::string & realm
) = 0;
Sets the status code to 401 (Unauthorized) and sets the "WWW-Authenticate" header field according to the given realm.
virtual std::ostream & send() = 0;
Sends the response header to the client and returns an output stream for sending the response body.
The returned stream is valid until the response object is destroyed.
virtual void sendBuffer(
const void * pBuffer,
) = 0;
Sends the response header to the client, followed by the contents of the given buffer.
The Content-Length header of the response is set to length and chunked transfer encoding is disabled.
If both the HTTP message header and body (from the given buffer) fit into one single network packet, the complete response can be sent in one network packet.
virtual void sendContinue() = 0;
Sends a 100 Continue response to the client.
virtual void sendFile(
const std::string & path,
const std::string & mediaType
) = 0;
Sends the response header to the client, followed by the content of the given file.
virtual bool sent() const = 0;
Returns true if the response (header) has been sent.