#include <HTTPResponseWriter.hpp>

Inherits pion::net::HTTPWriter, and enable_shared_from_this< HTTPResponseWriter >.

Public Member Functions
virtual	~HTTPResponseWriter ()
	default destructor

HTTPResponse &	getResponse (void)
	returns a non-const reference to the response that will be sent

Public Member Functions inherited from pion::net::HTTPWriter
virtual	~HTTPWriter ()
	default destructor

void	clear (void)
	clears out all of the memory buffers used to cache payload content data

template<typename T >
void	write (const T &data)

void	write (const void *data, size_t length)

void	writeNoCopy (const std::string &data)

void	writeNoCopy (void *data, size_t length)

void	send (void)

template<typename SendHandler >
void	send (SendHandler send_handler)

template<typename SendHandler >
void	sendChunk (SendHandler send_handler)

template<typename SendHandler >
void	sendFinalChunk (SendHandler send_handler)

void	sendFinalChunk (void)

TCPConnectionPtr &	getTCPConnection (void)
	returns a shared pointer to the TCP connection

size_t	getContentLength (void) const
	returns the length of the payload content (in bytes)

void	supportsChunkedMessages (bool b)
	sets whether or not the client supports chunked messages

bool	supportsChunkedMessages () const
	returns true if the client supports chunked messages

bool	sendingChunkedMessage () const
	returns true if we are sending a chunked message to the client

void	setLogger (PionLogger log_ptr)
	sets the logger to be used

PionLogger	getLogger (void)
	returns the logger currently in use

Static Public Member Functions
static boost::shared_ptr < HTTPResponseWriter >	create (TCPConnectionPtr &tcp_conn, HTTPResponsePtr &http_response, FinishedHandler handler=FinishedHandler())

static boost::shared_ptr < HTTPResponseWriter >	create (TCPConnectionPtr &tcp_conn, const HTTPRequest &http_request, FinishedHandler handler=FinishedHandler())

Protected Member Functions
	HTTPResponseWriter (TCPConnectionPtr &tcp_conn, HTTPResponsePtr &http_response, FinishedHandler handler)

	HTTPResponseWriter (TCPConnectionPtr &tcp_conn, const HTTPRequest &http_request, FinishedHandler handler)

virtual void	prepareBuffersForSend (HTTPMessage::WriteBuffers &write_buffers)

virtual WriteHandler	bindToWriteHandler (void)
	returns a function bound to HTTPWriter::handleWrite()

virtual void	handleWrite (const boost::system::error_code &write_error, std::size_t bytes_written)

Protected Member Functions inherited from pion::net::HTTPWriter
	HTTPWriter (TCPConnectionPtr &tcp_conn, FinishedHandler handler)

void	finishedWriting (const boost::system::error_code &ec)
	called after we have finished sending the HTTP message

Additional Inherited Members
Protected Types inherited from pion::net::HTTPWriter
typedef boost::function1< void, const boost::system::error_code & >	FinishedHandler
	function called after the HTTP message has been sent

typedef boost::function2< void, const boost::system::error_code &, std::size_t >	WriteHandler
	data type for a function that handles write operations

Detailed Description

HTTPResponseWriter: used to asynchronously send HTTP responses

Definition at line 30 of file HTTPResponseWriter.hpp.

Constructor & Destructor Documentation

pion::net::HTTPResponseWriter::HTTPResponseWriter	(	TCPConnectionPtr &	tcp_conn,
		HTTPResponsePtr &	http_response,
		FinishedHandler	handler
	)

inlineprotected

protected constructor restricts creation of objects (use create())

Parameters

tcp_conn	TCP connection used to send the response
http_response	pointer to the response that will be sent
handler	function called after the request has been sent

Definition at line 86 of file HTTPResponseWriter.hpp.

pion::net::HTTPResponseWriter::HTTPResponseWriter	(	TCPConnectionPtr &	tcp_conn,
		const HTTPRequest &	http_request,
		FinishedHandler	handler
	)

inlineprotected

protected constructor restricts creation of objects (use create())

Parameters

tcp_conn	TCP connection used to send the response
http_request	the request we are responding to
handler	function called after the request has been sent

Definition at line 110 of file HTTPResponseWriter.hpp.

Member Function Documentation

static boost::shared_ptr<HTTPResponseWriter> pion::net::HTTPResponseWriter::create	(	TCPConnectionPtr &	tcp_conn,
		HTTPResponsePtr &	http_response,
		FinishedHandler	handler = `FinishedHandler()`
	)

inlinestatic

creates new HTTPResponseWriter objects

Parameters

tcp_conn	TCP connection used to send the response
http_response	pointer to the response that will be sent
handler	function called after the response has been sent

Returns: boost::shared_ptr<HTTPResponseWriter> shared pointer to the new writer object that was created

Definition at line 49 of file HTTPResponseWriter.hpp.

Referenced by pion::net::HTTPServer::handleBadRequest(), pion::net::HTTPServer::handleForbiddenRequest(), pion::net::HTTPServer::handleMethodNotAllowed(), pion::net::HTTPServer::handleNotFoundRequest(), pion::net::HTTPCookieAuth::handleOk(), pion::net::HTTPCookieAuth::handleRedirection(), pion::net::HTTPServer::handleServerError(), pion::net::HTTPBasicAuth::handleUnauthorized(), pion::net::HTTPCookieAuth::handleUnauthorized(), pion::plugins::AllowNothingService::operator()(), pion::plugins::CookieService::operator()(), pion::plugins::EchoService::operator()(), and pion::plugins::HelloService::operator()().

static boost::shared_ptr<HTTPResponseWriter> pion::net::HTTPResponseWriter::create	(	TCPConnectionPtr &	tcp_conn,
		const HTTPRequest &	http_request,
		FinishedHandler	handler = `FinishedHandler()`
	)

inlinestatic

creates new HTTPResponseWriter objects

Parameters

tcp_conn	TCP connection used to send the response
http_request	the request we are responding to
handler	function called after the request has been sent

Returns: boost::shared_ptr<HTTPResponseWriter> shared pointer to the new writer object that was created

Definition at line 66 of file HTTPResponseWriter.hpp.

virtual void pion::net::HTTPResponseWriter::handleWrite	(	const boost::system::error_code &	write_error,
		std::size_t	bytes_written
	)

inlineprotectedvirtual

called after the response is sent

Parameters

write_error	error status from the last write operation
bytes_written	number of bytes sent by the last write operation

Implements pion::net::HTTPWriter.

Definition at line 146 of file HTTPResponseWriter.hpp.

Referenced by bindToWriteHandler().

virtual void pion::net::HTTPResponseWriter::prepareBuffersForSend ( HTTPMessage::WriteBuffers & write_buffers )

inlineprotectedvirtual

initializes a vector of write buffers with the HTTP message information

Parameters

write_buffers vector of write buffers to initialize

Implements pion::net::HTTPWriter.

Definition at line 125 of file HTTPResponseWriter.hpp.

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

net/include/pion/net/HTTPResponseWriter.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation