class HTTPServerResponse

File Information

Library: Net
Package: HTTPServer
Header: Poco/Net/HTTPServerResponse.h


This subclass of HTTPResponse is used for representing server-side HTTP responses.

A HTTPServerResponse is passed to the handleRequest() method of HTTPRequestHandler.

handleRequest() must set a status code and optional reason phrase, set headers as necessary, and provide a message body.


Direct Base Classes: HTTPResponse

All Base Classes: HTTPMessage, HTTPResponse, MessageHeader, NameValueCollection

Known Derived Classes: HTTPServerResponseImpl

Member Summary

Member Functions: redirect, requireAuthentication, send, sendBuffer, sendContinue, sendFile, sent

Inherited Functions: add, addCookie, begin, clear, decodeRFC2047, decodeWord, empty, end, erase, find, get, getAutoDecode, getChunkedTransferEncoding, getContentLength, getContentLength64, getContentType, getCookies, getDate, getDecoded, getFieldLimit, getKeepAlive, getNameLengthLimit, getReason, getReasonForStatus, getStatus, getTransferEncoding, getValueLengthLimit, getVersion, has, hasContentLength, hasToken, operator =, operator [], quote, read, set, setAutoDecode, setChunkedTransferEncoding, setContentLength, setContentLength64, setContentType, setDate, setFieldLimit, setKeepAlive, setNameLengthLimit, setReason, setStatus, setStatusAndReason, setTransferEncoding, setValueLengthLimit, setVersion, size, splitElements, splitParameters, swap, write




Creates the HTTPServerResponse.


~HTTPServerResponse virtual


Destroys the HTTPServerResponse.

Member Functions

redirect virtual

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.

requireAuthentication virtual

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.

send virtual

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.

Must not be called after sendFile(), sendBuffer() or redirect() has been called.

sendBuffer virtual

virtual void sendBuffer(
    const void * pBuffer,
    std::size_t length
) = 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.

Must not be called after send(), sendFile() or redirect() has been called.

sendContinue virtual

virtual void sendContinue() = 0;

Sends a 100 Continue response to the client.

sendFile virtual

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.

Must not be called after send(), sendBuffer() or redirect() has been called.

Throws a FileNotFoundException if the file cannot be found, or an OpenFileException if the file cannot be opened.

sent virtual

virtual bool sent() const = 0;

Returns true if the response (header) has been sent.