pion::http::request_writer Class Reference

#include <request_writer.hpp>

Inheritance diagram for pion::http::request_writer:

Collaboration diagram for pion::http::request_writer:

Public Member Functions
virtual	~request_writer ()
	default destructor More...
http::request &	get_request (void)
	returns a non-const reference to the request that will be sent More...
Public Member Functions inherited from pion::http::writer
virtual	~writer ()
	default destructor More...
void	clear (void)
	clears out all of the memory buffers used to cache payload content data More...
template<typename T >
void	write (const T &data)
void	write (std::ostream &(*iomanip)(std::ostream &))
void	write (const void *data, size_t length)
void	write_no_copy (const std::string &data)
void	write_no_copy (void *data, size_t length)
void	send (void)
template<typename SendHandler >
void	send (SendHandler send_handler)
template<typename SendHandler >
void	send_chunk (SendHandler send_handler)
template<typename SendHandler >
void	send_final_chunk (SendHandler send_handler)
void	send_final_chunk (void)
tcp::connection_ptr &	get_connection (void)
	returns a shared pointer to the TCP connection More...
size_t	get_content_length (void) const
	returns the length of the payload content (in bytes) More...
void	supports_chunked_messages (bool b)
	sets whether or not the client supports chunked messages More...
bool	supports_chunked_messages () const
	returns true if the client supports chunked messages More...
bool	sending_chunked_message () const
	returns true if we are sending a chunked message to the client More...
void	set_logger (logger log_ptr)
	sets the logger to be used More...
logger	get_logger (void)
	returns the logger currently in use More...

Static Public Member Functions
static boost::shared_ptr < request_writer >	create (const tcp::connection_ptr &tcp_conn, finished_handler_t handler=finished_handler_t())
static boost::shared_ptr < request_writer >	create (const tcp::connection_ptr &tcp_conn, const http::request_ptr &http_request_ptr, finished_handler_t handler=finished_handler_t())

Protected Member Functions
	request_writer (const tcp::connection_ptr &tcp_conn, finished_handler_t handler)
	request_writer (const tcp::connection_ptr &tcp_conn, const http::request_ptr &http_request_ptr, finished_handler_t handler)
virtual void	prepare_buffers_for_send (http::message::write_buffers_t &write_buffers)
virtual write_handler_t	bind_to_write_handler (void)
	returns a function bound to http::writer::handle_write() More...
virtual void	handle_write (const boost::system::error_code &write_error, std::size_t bytes_written)
Protected Member Functions inherited from pion::http::writer
	writer (const tcp::connection_ptr &tcp_conn, finished_handler_t handler)
void	finished_writing (const boost::system::error_code &ec)
	called after we have finished sending the HTTP message More...

Additional Inherited Members
Protected Types inherited from pion::http::writer
typedef boost::function1< void, const boost::system::error_code & >	finished_handler_t
	function called after the HTTP message has been sent More...
typedef boost::function2< void, const boost::system::error_code &, std::size_t >	write_handler_t
	data type for a function that handles write operations More...

Detailed Description

request_writer: used to asynchronously send HTTP requests

Constructor & Destructor Documentation

virtual pion::http::request_writer::~request_writer ( )

inlinevirtual

default destructor

pion::http::request_writer::request_writer ( const tcp::connection_ptr &  tcp_conn, finished_handler_t  handler  )

inlineprotected

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

Parameters

tcp_conn	TCP connection used to send the request
handler	function called after the request has been sent

References PION_GET_LOGGER, and pion::http::writer::set_logger().

Referenced by create().

pion::http::request_writer::request_writer ( const tcp::connection_ptr &  tcp_conn, const http::request_ptr &  http_request_ptr, finished_handler_t  handler  )

inlineprotected

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

Parameters

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

References PION_GET_LOGGER, pion::http::writer::set_logger(), and pion::http::writer::write_no_copy().

Member Function Documentation

virtual write_handler_t pion::http::request_writer::bind_to_write_handler ( void  )

inlineprotectedvirtual

returns a function bound to http::writer::handle_write()

Implements pion::http::writer.

References handle_write().

static boost::shared_ptr<request_writer> pion::http::request_writer::create ( const tcp::connection_ptr &  tcp_conn, finished_handler_t  handler = finished_handler_t()  )

inlinestatic

creates new request_writer objects

Parameters

tcp_conn	TCP connection used to send the request
handler	function called after the request has been sent

Returns

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

References request_writer().

static boost::shared_ptr<request_writer> pion::http::request_writer::create ( const tcp::connection_ptr &  tcp_conn, const http::request_ptr &  http_request_ptr, finished_handler_t  handler = finished_handler_t()  )

inlinestatic

creates new request_writer objects

Parameters

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

Returns

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

References request_writer().

http::request& pion::http::request_writer::get_request ( void  )

inline

returns a non-const reference to the request that will be sent

virtual void pion::http::request_writer::handle_write ( const boost::system::error_code &  write_error, std::size_t  bytes_written  )

inlineprotectedvirtual

called after the request 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::http::writer.

References pion::http::writer::clear(), pion::http::writer::finished_writing(), pion::http::writer::get_logger(), PION_LOG_DEBUG, and pion::http::writer::sending_chunked_message().

Referenced by bind_to_write_handler().

virtual void pion::http::request_writer::prepare_buffers_for_send ( http::message::write_buffers_t &  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::http::writer.

References pion::http::writer::get_connection(), pion::http::writer::get_content_length(), and pion::http::writer::sending_chunked_message().

---

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

• include/pion/http/request_writer.hpp