Defines an object to assist a servlet in sending a response to the client. More...

#include <response.h>

Inheritance diagram for servlet::http_response:

Public Member Functions
virtual void	add_cookie (const cookie &c)=0
	Adds the specified cookie to the response. More...

virtual void	add_header (const std::string &name, const std::string &value)=0
	Adds a response header with the given name and value. More...

template<typename Clock , typename Dur >
void	add_date_header (const std::string &name, const std::chrono::time_point< Clock, Dur > &date)
	Adds a response header with the given name and date-value. More...

virtual void	add_date_header (const std::string &name, long timeSec)=0
	Adds a response header with the given name and date-value. More...

virtual void	set_header (const std::string &name, const std::string &value)=0
	Sets a response header with the given name and value. More...

template<typename Clock , typename Dur >
void	set_date_header (const std::string &name, const std::chrono::time_point< Clock, Dur > &date)
	Sets a response header with the given name and date-value. More...

virtual void	set_date_header (const std::string &name, long date)=0
	Sets a response header with the given name and date-value. More...

virtual bool	contains_header (const std::string &name) const =0
	Returns a boolean indicating whether the named response header has already been set. More...

virtual string_view	get_header (const std::string &name) const =0
	Return the value for the specified header, or empty string if this header has not been set. More...

virtual long	get_date_header (const std::string &name) const =0
	Return the date value for the specified header, or `-1` if this header has not been set. More...

virtual void	get_headers (const std::string &name, std::vector< std::string > &headers) const =0
	Fills the `std::vector` with all the header values associated with the specified header name. More...

virtual void	get_headers (std::vector< std::pair< std::string, std::string >> &headers) const =0
	Fills the `std::vector` with all the response header values. More...

virtual string_view	get_content_type () const =0
	Returns the content type used for the MIME body sent in this response. More...

virtual void	set_content_type (const std::string &type)=0
	Sets the content type of the response being sent to the client, if the response has not been committed yet. More...

virtual void	set_content_length (std::size_t len)=0
	Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header. More...

virtual void	send_redirect (const std::string &redirectURL)=0
	Sends a temporary redirect response to the client using the specified redirect location URL. More...

virtual void	set_status (int sc)=0
	Sets the status code for this response. More...

virtual int	get_status () const =0
	Get the HTTP status code for this Response. More...

virtual std::ostream &	get_output_stream ()=0
	Returns a `std::ostream` suitable for writing binary data in the response. More...

Static Public Attributes
static constexpr int	SC_CONTINUE = 100
	Status code (100) indicating the client can continue.

static constexpr int	SC_SWITCHING_PROTOCOLS = 101
	Status code (101) indicating the server is switching protocols according to Upgrade header.

static constexpr int	SC_OK = 200
	Status code (200) indicating the request succeeded normally.

static constexpr int	SC_CREATED = 201
	Status code (201) indicating the request succeeded and created a new resource on the server.

static constexpr int	SC_ACCEPTED = 202
	Status code (202) indicating that a request was accepted for processing, but was not completed.

static constexpr int	SC_NON_AUTHORITATIVE_INFORMATION = 203
	Status code (203) indicating that the meta information presented by the client did not originate from the server.

static constexpr int	SC_NO_CONTENT = 204
	Status code (204) indicating that the request succeeded but that there was no new information to return.

static constexpr int	SC_RESET_CONTENT = 205
	Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.

static constexpr int	SC_PARTIAL_CONTENT = 206
	Status code (206) indicating that the server has fulfilled the partial GET request for the resource.

static constexpr int	SC_MULTIPLE_CHOICES = 300
	Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location.

static constexpr int	SC_MOVED_PERMANENTLY = 301
	Status code (301) indicating that the resource has permanently moved to a new location, and that future references should use a new URI with their requests.

static constexpr int	SC_MOVED_TEMPORARILY = 302
	Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource. More...

static constexpr int	SC_FOUND = 302
	Status code (302) indicating that the resource reside temporarily under a different URI. More...

static constexpr int	SC_SEE_OTHER = 303
	Status code (303) indicating that the response to the request can be found under a different URI.

static constexpr int	SC_NOT_MODIFIED = 304
	Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.

static constexpr int	SC_USE_PROXY = 305
	Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the `Location` field.

static constexpr int	SC_TEMPORARY_REDIRECT = 307
	Status code (307) indicating that the requested resource resides temporarily under a different URI. More...

static constexpr int	SC_BAD_REQUEST = 400
	Status code (400) indicating the request sent by the client was syntactically incorrect.

static constexpr int	SC_UNAUTHORIZED = 401
	Status code (401) indicating that the request requires HTTP authentication.

static constexpr int	SC_PAYMENT_REQUIRED = 402
	Status code (402) reserved for future use.

static constexpr int	SC_FORBIDDEN = 403
	Status code (403) indicating the server understood the request but refused to fulfill it.

static constexpr int	SC_NOT_FOUND = 404
	Status code (404) indicating that the requested resource is not available.

static constexpr int	SC_METHOD_NOT_ALLOWED = 405
	Status code (405) indicating that the method specified in the `Request-Line` is not allowed for the resource identified by the `Request-URI`.

static constexpr int	SC_NOT_ACCEPTABLE = 406
	Status code (406) indicating that the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

static constexpr int	SC_PROXY_AUTHENTICATION_REQUIRED = 407
	Status code (407) indicating that the client MUST first authenticate itself with the proxy.

static constexpr int	SC_REQUEST_TIMEOUT = 408
	Status code (408) indicating that the client did not produce a request within the time that the server was prepared to wait.

static constexpr int	SC_CONFLICT = 409
	Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.

static constexpr int	SC_GONE = 410
	Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known. More...

static constexpr int	SC_LENGTH_REQUIRED = 411
	Status code (411) indicating that the request cannot be handled without a defined `Content-Length`.

static constexpr int	SC_PRECONDITION_FAILED = 412
	Status code (412) indicating that the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.

static constexpr int	SC_REQUEST_ENTITY_TOO_LARGE = 413
	Status code (413) indicating that the server is refusing to process the request because the request entity is larger than the server is willing or able to process.

static constexpr int	SC_REQUEST_URI_TOO_LONG = 414
	Status code (414) indicating that the server is refusing to service the request because the `Request-URI` is longer than the server is willing to interpret.

static constexpr int	SC_UNSUPPORTED_MEDIA_TYPE = 415
	Status code (415) indicating that the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.

static constexpr int	SC_REQUESTED_RANGE_NOT_SATISFIABLE = 416
	Status code (416) indicating that the server cannot serve the requested byte range.

static constexpr int	SC_EXPECTATION_FAILED = 417
	Status code (417) indicating that the server could not meet the expectation given in the Expect request header.

static constexpr int	SC_INTERNAL_SERVER_ERROR = 500
	Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request.

static constexpr int	SC_NOT_IMPLEMENTED = 501
	Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request.

static constexpr int	SC_BAD_GATEWAY = 502
	Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway.

static constexpr int	SC_SERVICE_UNAVAILABLE = 503
	Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request.

static constexpr int	SC_GATEWAY_TIMEOUT = 504
	Status code (504) indicating that the server did not receive a timely response from the upstream server while acting as a gateway or proxy.

static constexpr int	SC_HTTP_VERSION_NOT_SUPPORTED = 505
	Status code (505) indicating that the server does not support or refuses to support the HTTP protocol version that was used in the request message.

Detailed Description

Defines an object to assist a servlet in sending a response to the client.

The servlet container creates a http_response object and passes it as an argument to the servlet's service method.

To send binary data in a response, use the std::ostream returned by get_output_stream

Member Function Documentation

virtual void servlet::http_response::add_cookie ( const cookie & c )

pure virtual

Adds the specified cookie to the response.

This method can be called multiple times to set more than one cookie.

Parameters

c	the Cookie to return to the client

Implemented in servlet::http_response_wrapper.

template<typename Clock , typename Dur >

void servlet::http_response::add_date_header	(	const std::string &	name,
		const std::chrono::time_point< Clock, Dur > &	date
	)

inline

Adds a response header with the given name and date-value.

The date is specified as std::chrono::time_point. This method allows response headers to have multiple values.

Template Parameters

Clock	clock type of the date
Dur	duration type of the date

Parameters

name	the name of the header to set
date	the additional date value

See Also: set_date_header

virtual void servlet::http_response::add_date_header	(	const std::string &	name,
		long	timeSec
	)

pure virtual

Adds a response header with the given name and date-value.

The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.

Parameters

name	the name of the header to set
timeSec	the additional date value

See Also: set_date_header

Implemented in servlet::http_response_wrapper.

virtual void servlet::http_response::add_header	(	const std::string &	name,
		const std::string &	value
	)

pure virtual

Adds a response header with the given name and value.

This method allows response headers to have multiple values.

Parameters

name	the name of the header
value	the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

See Also: set_header

Implemented in servlet::http_response_wrapper.

virtual bool servlet::http_response::contains_header ( const std::string & name ) const

pure virtual

Returns a boolean indicating whether the named response header has already been set.

Parameters

name	the header name

Returns: true if the named response header has already been set; false otherwise

Implemented in servlet::http_response_wrapper.

virtual string_view servlet::http_response::get_content_type ( ) const

pure virtual

Returns the content type used for the MIME body sent in this response.

The content type proper must have been specified using set_content_type before the response is committed. If no content type has been specified, this method returns null.

Returns: a string_view specifying the content type, for example, text/html; charset=UTF-8, or null

Implemented in servlet::http_response_wrapper.

virtual long servlet::http_response::get_date_header ( const std::string & name ) const

pure virtual

Return the date value for the specified header, or -1 if this header has not been set.

If date value cannot be parsed from the header value stack_bad_cast exception will be thrown. to retrieve all of them.

Parameters

name	Header name to look up

Returns: The first value for the specified header converted into long.

Implemented in servlet::http_response_wrapper.

virtual string_view servlet::http_response::get_header ( const std::string & name ) const

pure virtual

Return the value for the specified header, or empty string if this header has not been set.

If more than one value was added for this name, only the first is returned; use get_headers(const std::string&, std::vector<std::string>&) to retrieve all of them.

Parameters

name	Header name to look up

Returns: The first value for the specified header. This is the raw value so if multiple values are specified in the first header then they will be returned as a single header value .

Implemented in servlet::http_response_wrapper.

virtual void servlet::http_response::get_headers	(	const std::string &	name,
		std::vector< std::string > &	headers
	)		const

pure virtual

Fills the std::vector with all the header values associated with the specified header name.

Parameters

name	Header name to look up
headers	The values for the specified header. These are the raw values so if multiple values are specified in a single header that will be returned as a single header value.

Implemented in servlet::http_response_wrapper.

virtual void servlet::http_response::get_headers ( std::vector< std::pair< std::string, std::string >> & headers ) const

pure virtual

Fills the std::vector with all the response header values.

Parameters

headers The values for the headers.

Implemented in servlet::http_response_wrapper.

virtual std::ostream& servlet::http_response::get_output_stream ( )

pure virtual

Returns a std::ostream suitable for writing binary data in the response.

The servlet container does not encode the binary data.

Returns: a std::ostream for writing binary data

Implemented in servlet::http_response_wrapper.

virtual int servlet::http_response::get_status ( ) const

pure virtual

Get the HTTP status code for this Response.

Returns: The HTTP status code for this Response

Implemented in servlet::http_response_wrapper.

virtual void servlet::http_response::send_redirect ( const std::string & redirectURL )

pure virtual

Sends a temporary redirect response to the client using the specified redirect location URL.

This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Parameters

redirectURL the redirect location URL

Implemented in servlet::http_response_wrapper.

virtual void servlet::http_response::set_content_length ( std::size_t len )

pure virtual

Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

Parameters

len	an `std::size_t` specifying the length of the content being returned to the client; sets the Content-Length header

Implemented in servlet::http_response_wrapper.

virtual void servlet::http_response::set_content_type ( const std::string & type )

pure virtual

Sets the content type of the response being sent to the client, if the response has not been committed yet.

The given content type may include a character encoding specification, for example, text/html;charset=UTF-8.

This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after get_output_stream has been called or after the response has been committed.

Parameters

type	a `std::string` specifying the MIME type of the content

See Also: get_output_stream

Implemented in servlet::http_response_wrapper.

template<typename Clock , typename Dur >

void servlet::http_response::set_date_header	(	const std::string &	name,
		const std::chrono::time_point< Clock, Dur > &	date
	)

inline

Sets a response header with the given name and date-value.

The date is specified as std::chrono::time_point. If the header had already been set, the new value overwrites the previous one. The contains_header method can be used to test for the presence of a header before setting its value.

Template Parameters

Clock	clock type of the date
Dur	duration type of the date

Parameters

name	the name of the header to set
date	the assigned date value

See Also: contains_header; add_date_header

virtual void servlet::http_response::set_date_header	(	const std::string &	name,
		long	date
	)

pure virtual

Sets a response header with the given name and date-value.

The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. The contains_header method can be used to test for the presence of a header before setting its value.

Parameters

name	the name of the header to set
date	the assigned date value

See Also: contains_header; add_date_header

Implemented in servlet::http_response_wrapper.

virtual void servlet::http_response::set_header	(	const std::string &	name,
		const std::string &	value
	)

pure virtual

Sets a response header with the given name and value.

If the header had already been set, the new value overwrites the previous one. The contains_header method can be used to test for the presence of a header before setting its value.

Parameters

name	the name of the header
value	the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

See Also: contains_header; add_header

Implemented in servlet::http_response_wrapper.

virtual void servlet::http_response::set_status ( int sc )

pure virtual

Sets the status code for this response.

This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY).

The container clears the buffer and sets the Location header, preserving cookies and other headers.

Parameters

sc	the status code

Implemented in servlet::http_response_wrapper.

Member Data Documentation

constexpr int servlet::http_response::SC_FOUND = 302

static

Status code (302) indicating that the resource reside temporarily under a different URI.

Since the redirection might be altered on occasion, the client should continue to use the Request-URI for future requests. (HTTP/1.1) To represent the status code (302), it is recommended to use this variable.

constexpr int servlet::http_response::SC_GONE = 410

static

Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known.

This condition SHOULD be considered permanent.

constexpr int servlet::http_response::SC_MOVED_TEMPORARILY = 302

static

Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource.

This definition is being retained for backwards compatibility. SC_FOUND is now the preferred definition.

constexpr int servlet::http_response::SC_TEMPORARY_REDIRECT = 307

static

Status code (307) indicating that the requested resource resides temporarily under a different URI.

The temporary URI SHOULD be given by the Location field in the response.

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

include/servlet/response.h

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation