#include <Response.h>

Collaboration diagram for express::Response:

Public Member Functions
	Response (const std::shared_ptr< web::http::server::Response > &response) noexcept

	Response (Response &)=delete

	Response (Response &&) noexcept=delete

Response &	operator= (Response &)=delete

Response &	operator= (Response &&) noexcept=delete

	~Response ()

web::http::server::SocketContext *	getSocketContext () const

void	json (const nlohmann::json &json)

void	download (const std::string &file, const std::function< void(int)> &onError)

void	download (const std::string &file, const std::string &fileName, const std::function< void(int)> &onError)

void	redirect (const std::string &loc)

void	redirect (int state, const std::string &loc)

void	sendStatus (int state)

Response &	attachment (const std::string &fileName="")

Response &	location (const std::string &loc)

Response &	vary (const std::string &field)

Response &	status (int status)

Response &	append (const std::string &field, const std::string &value)

Response &	set (const std::string &field, const std::string &value, bool overwrite=true)

Response &	set (const std::map< std::string, std::string > &headers, bool overwrite=true)

Response &	type (const std::string &type)

Response &	cookie (const std::string &name, const std::string &value, const std::map< std::string, std::string > &options={})

Response &	clearCookie (const std::string &name, const std::map< std::string, std::string > &options={})

Response &	setTrailer (const std::string &field, const std::string &value, bool overwrite=true)

void	send (const char *chunk, std::size_t chunkLen)

void	send (const std::string &chunk)

void	upgrade (const std::shared_ptr< Request > &request, const std::function< void(const std::string)> &status)

void	end ()

void	sendFile (const std::string &file, const std::function< void(int)> &callback)

Response &	sendHeader ()

Response &	sendFragment (const char *chunk, std::size_t chunkLen)

Response &	sendFragment (const std::string &chunk)

const std::string &	header (const std::string &field)

Private Attributes
std::shared_ptr< web::http::server::Response >	responseBase

Detailed Description

Definition at line 67 of file Response.h.

Constructor & Destructor Documentation

◆ Response() [1/3]

express::Response::Response ( const std::shared_ptr< web::http::server::Response > & response )

explicitnoexcept

Definition at line 57 of file Response.cpp.

58 : responseBase(response) {

59 }

express::Response::responseBase

std::shared_ptr< web::http::server::Response > responseBase

Definition Response.h:96

References Response().

Referenced by Response().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Response() [2/3]

express::Response::Response ( Response & )

explicitdelete

◆ Response() [3/3]

express::Response::Response ( Response && )

explicitdeletenoexcept

◆ ~Response()

express::Response::~Response ( )

Definition at line 61 of file Response.cpp.

61 {

62 }

Member Function Documentation

◆ append()

Response & express::Response::append	(	const std::string &	field,
		const std::string &	value )

Definition at line 119 of file Response.cpp.

                                                                             {
        responseBase->append(field, value);
 
        return *this;
    }

◆ attachment()

Response & express::Response::attachment ( const std::string & fileName = "" )

Definition at line 95 of file Response.cpp.

                                                            {
        set("Content-Disposition", "attachment" + ((!fileName.empty()) ? ("; filename=\"" + fileName + "\"") : ""));
 
        return *this;
    }

◆ clearCookie()

Response & express::Response::clearCookie	(	const std::string &	name,
		const std::map< std::string, std::string > &	options = {} )

Definition at line 149 of file Response.cpp.

                                                                                                      {
        responseBase->clearCookie(name, options);
 
        return *this;
    }

◆ cookie()

Response & express::Response::cookie	(	const std::string &	name,
		const std::string &	value,
		const std::map< std::string, std::string > &	options = {} )

Definition at line 143 of file Response.cpp.

                                                                                                                         {
        responseBase->cookie(name, value, options);
 
        return *this;
    }

◆ download() [1/2]

void express::Response::download	(	const std::string &	file,
		const std::function< void(int)> &	onError )

Definition at line 73 of file Response.cpp.

                                                                                        {
        download(file, std::filesystem::path(file).filename(), onError);
    }

◆ download() [2/2]

void express::Response::download	(	const std::string &	file,
		const std::string &	fileName,
		const std::function< void(int)> &	onError )

Definition at line 77 of file Response.cpp.

                                                                                                                   {
        attachment(fileName);
        sendFile(file, onError);
    }

◆ end()

void express::Response::end ( )

Definition at line 173 of file Response.cpp.

                       {
        responseBase->end();
    }

◆ getSocketContext()

web::http::server::SocketContext * express::Response::getSocketContext ( ) const

Definition at line 64 of file Response.cpp.

                                                                 {
        return responseBase->getSocketContext();
    }

◆ header()

const std::string & express::Response::header ( const std::string & field )

Definition at line 199 of file Response.cpp.

                                                            {
        return responseBase->header(field);
    }

◆ json()

void express::Response::json ( const nlohmann::json & json )

Definition at line 68 of file Response.cpp.

                                                {
        set("Content-Type", "application/json");
        send(json.dump());
    }

◆ location()

Response & express::Response::location ( const std::string & loc )

Definition at line 101 of file Response.cpp.

                                                     {
        set("Location", loc);
 
        return *this;
    }

◆ operator=() [1/2]

Response & express::Response::operator= ( Response && )

deletenoexcept

◆ operator=() [2/2]

Response & express::Response::operator= ( Response & )

delete

◆ redirect() [1/2]

void express::Response::redirect ( const std::string & loc )

Definition at line 82 of file Response.cpp.

                                                {
        redirect(302, loc);
    }

◆ redirect() [2/2]

void express::Response::redirect	(	int	state,
		const std::string &	loc )

Definition at line 86 of file Response.cpp.

                                                           {
        location(loc);
        sendStatus(state);
    }

References sendStatus().

Here is the call graph for this function:

◆ send() [1/2]

void express::Response::send	(	const char *	chunk,
		std::size_t	chunkLen )

Definition at line 161 of file Response.cpp.

                                                             {
        responseBase->send(chunk, chunkLen);
    }

◆ send() [2/2]

void express::Response::send ( const std::string & chunk )

Definition at line 165 of file Response.cpp.

                                              {
        responseBase->send(chunk);
    }

◆ sendFile()

void express::Response::sendFile	(	const std::string &	file,
		const std::function< void(int)> &	callback )

Definition at line 177 of file Response.cpp.

                                                                                         {
        responseBase->sendFile(file, callback);
    }

◆ sendFragment() [1/2]

Response & express::Response::sendFragment	(	const char *	chunk,
		std::size_t	chunkLen )

Definition at line 187 of file Response.cpp.

                                                                          {
        responseBase->sendFragment(chunk, chunkLen);
 
        return *this;
    }

◆ sendFragment() [2/2]

Response & express::Response::sendFragment ( const std::string & chunk )

Definition at line 193 of file Response.cpp.

                                                           {
        responseBase->sendFragment(chunk);
 
        return *this;
    }

◆ sendHeader()

Response & express::Response::sendHeader ( )

Definition at line 181 of file Response.cpp.

                                   {
        responseBase->sendHeader();
 
        return *this;
    }

◆ sendStatus()

void express::Response::sendStatus ( int state )

Definition at line 91 of file Response.cpp.

                                       {
        this->status(state).send(web::http::StatusCode::reason(state) + "\r\n");
    }

Referenced by redirect().

Here is the caller graph for this function:

◆ set() [1/2]

Response & express::Response::set	(	const std::map< std::string, std::string > &	headers,
		bool	overwrite = true )

Definition at line 131 of file Response.cpp.

                                                                                       {
        responseBase->set(headers, overwrite);
 
        return *this;
    }

◆ set() [2/2]

Response & express::Response::set	(	const std::string &	field,
		const std::string &	value,
		bool	overwrite = true )

Definition at line 125 of file Response.cpp.

                                                                                          {
        responseBase->set(field, value, overwrite);
 
        return *this;
    }

◆ setTrailer()

Response & express::Response::setTrailer	(	const std::string &	field,
		const std::string &	value,
		bool	overwrite = true )

Definition at line 155 of file Response.cpp.

                                                                                                 {
        responseBase->setTrailer(field, value, overwrite);
 
        return *this;
    }

◆ status()

Response & express::Response::status ( int status )

Definition at line 113 of file Response.cpp.

                                         {
        responseBase->status(status);
 
        return *this;
    }

◆ type()

Response & express::Response::type ( const std::string & type )

Definition at line 137 of file Response.cpp.

                                                  {
        responseBase->type(type);
 
        return *this;
    }

◆ upgrade()

void express::Response::upgrade	(	const std::shared_ptr< Request > &	request,
		const std::function< void(const std::string)> &	status )

Definition at line 169 of file Response.cpp.

                                                                                                                  {
        responseBase->upgrade(request->requestBase, status);
    }

◆ vary()

Response & express::Response::vary ( const std::string & field )

Definition at line 107 of file Response.cpp.

                                                   {
        append("Vary", field);
 
        return *this;
    }

Member Data Documentation

◆ responseBase

std::shared_ptr<web::http::server::Response> express::Response::responseBase

private

Definition at line 96 of file Response.h.

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

express/Response.h
express/Response.cpp

Public Member Functions

Private Attributes