Wt
3.7.1
|
A resource response. More...
#include <Wt/Http/Response>
Public Member Functions | |
void | setStatus (int status) |
Sets the response status. More... | |
void | setContentLength (::uint64_t length) |
Sets the content length. More... | |
void | setMimeType (const std::string &mimeType) |
Set the content mime type. More... | |
void | addHeader (const std::string &name, const std::string &value) |
Add an HTTP header. More... | |
ResponseContinuation * | createContinuation () |
Create a continuation object for this response. More... | |
ResponseContinuation * | continuation () const |
Return the continuation, if one was created for this response. More... | |
std::ostream & | out () |
Returns the stream for getting the response output. | |
A resource response.
This class defines the HTTP response for a WResource request.
More specifically you can:
You may chose to provide only a partial response. In that case, use createContinuation() to create a continuation object to which you can annotate information for the next request to process the response further.
void Wt::Http::Response::addHeader | ( | const std::string & | name, |
const std::string & | value | ||
) |
Add an HTTP header.
Headers may be added only before setting the content mime-type (setMimeType()), and before streaming any data to the out() stream.
ResponseContinuation * Wt::Http::Response::continuation | ( | ) | const |
Return the continuation, if one was created for this response.
Returns the continuation that was previously created using createContinuation(), or 0 if no continuation was created yet.
ResponseContinuation * Wt::Http::Response::createContinuation | ( | ) |
Create a continuation object for this response.
A continuation is used to resume sending more data later for this response. There are two possible reasons for this:
A new call to handleRequest() will be made to retrieve more data.
void Wt::Http::Response::setContentLength | ( | ::uint64_t | length | ) |
Sets the content length.
If content length is known, use this method to set it. File downloads will see progress bars. If not set, Wt will use chunked transfers.
Always use this method instead of setting the Content-Length header with addHeader().
Headers may be added only before setting the content mime-type (setMimeType()), and before streaming any data to the out() stream.
void Wt::Http::Response::setMimeType | ( | const std::string & | mimeType | ) |
Set the content mime type.
The content mimetype is used by the browser to correctly interpret the resource.
void Wt::Http::Response::setStatus | ( | int | status | ) |
Sets the response status.
Unless a overriden, 200 OK will be assumed.