pion-net  4.0.9
Classes | Public Member Functions | Protected Types | Protected Member Functions | List of all members
pion::net::HTTPWriter Class Referenceabstract

#include <HTTPWriter.hpp>

Inherits noncopyable.

Inherited by pion::net::HTTPRequestWriter, and pion::net::HTTPResponseWriter.

Public Member Functions

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
 

Protected Types

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
 

Protected Member Functions

 HTTPWriter (TCPConnectionPtr &tcp_conn, FinishedHandler handler)
 
virtual void handleWrite (const boost::system::error_code &write_error, std::size_t bytes_written)=0
 
virtual void prepareBuffersForSend (HTTPMessage::WriteBuffers &write_buffers)=0
 
virtual WriteHandler bindToWriteHandler (void)=0
 returns a function bound to HTTPWriter::handleWrite()
 
void finishedWriting (const boost::system::error_code &ec)
 called after we have finished sending the HTTP message
 

Detailed Description

HTTPWriter: used to asynchronously send HTTP messages

Definition at line 33 of file HTTPWriter.hpp.

Constructor & Destructor Documentation

pion::net::HTTPWriter::HTTPWriter ( TCPConnectionPtr &  tcp_conn,
FinishedHandler  handler 
)
inlineprotected

protected constructor: only derived classes may create objects

Parameters
tcp_connTCP connection used to send the message
handlerfunction called after the request has been sent

Definition at line 51 of file HTTPWriter.hpp.

Member Function Documentation

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

called after the message is sent

Parameters
write_errorerror status from the last write operation
bytes_writtennumber of bytes sent by the last write operation

Implemented in pion::net::HTTPResponseWriter, and pion::net::HTTPRequestWriter.

virtual void pion::net::HTTPWriter::prepareBuffersForSend ( HTTPMessage::WriteBuffers write_buffers)
protectedpure virtual

initializes a vector of write buffers with the HTTP message information

Parameters
write_buffersvector of write buffers to initialize

Implemented in pion::net::HTTPResponseWriter, and pion::net::HTTPRequestWriter.

void pion::net::HTTPWriter::send ( void  )
inline

Sends all data buffered as a single HTTP message (without chunking). Following a call to this function, it is not thread safe to use your reference to the HTTPWriter object.

Definition at line 160 of file HTTPWriter.hpp.

template<typename SendHandler >
void pion::net::HTTPWriter::send ( SendHandler  send_handler)
inline

Sends all data buffered as a single HTTP message (without chunking). Following a call to this function, it is not thread safe to use your reference to the HTTPWriter object until the send_handler has been called.

Parameters
send_handlerfunction that is called after the message has been sent to the client. Your callback function must end the connection by calling TCPConnection::finish().

Definition at line 174 of file HTTPWriter.hpp.

template<typename SendHandler >
void pion::net::HTTPWriter::sendChunk ( SendHandler  send_handler)
inline

Sends all data buffered as a single HTTP chunk. Following a call to this function, it is not thread safe to use your reference to the HTTPWriter object until the send_handler has been called.

Parameters
send_handlerfunction that is called after the chunk has been sent to the client. Your callback function must end by calling one of sendChunk() or sendFinalChunk(). Also, be sure to clear() the writer before writing data to it.

Definition at line 189 of file HTTPWriter.hpp.

template<typename SendHandler >
void pion::net::HTTPWriter::sendFinalChunk ( SendHandler  send_handler)
inline

Sends all data buffered (if any) and also sends the final HTTP chunk. This function (either overloaded version) must be called following any calls to sendChunk(). Following a call to this function, it is not thread safe to use your reference to the HTTPWriter object until the send_handler has been called.

Parameters
send_handlerfunction that is called after the message has been sent to the client. Your callback function must end the connection by calling TCPConnection::finish().

Definition at line 212 of file HTTPWriter.hpp.

void pion::net::HTTPWriter::sendFinalChunk ( void  )
inline

Sends all data buffered (if any) and also sends the final HTTP chunk. This function (either overloaded version) must be called following any calls to sendChunk(). Following a call to this function, it is not thread safe to use your reference to the HTTPWriter object.

Definition at line 224 of file HTTPWriter.hpp.

template<typename T >
void pion::net::HTTPWriter::write ( const T &  data)
inline

write text (non-binary) payload content

Parameters
datathe data to append to the payload content

Definition at line 105 of file HTTPWriter.hpp.

void pion::net::HTTPWriter::write ( const void *  data,
size_t  length 
)
inline

write binary payload content

Parameters
datapoints to the binary data to append to the payload content
lengththe length, in bytes, of the binary data

Definition at line 116 of file HTTPWriter.hpp.

void pion::net::HTTPWriter::writeNoCopy ( const std::string &  data)
inline

write text (non-binary) payload content; the data written is not copied, and therefore must persist until the message has finished sending

Parameters
datathe data to append to the payload content

Definition at line 131 of file HTTPWriter.hpp.

Referenced by pion::net::HTTPRequestWriter::HTTPRequestWriter().

void pion::net::HTTPWriter::writeNoCopy ( void *  data,
size_t  length 
)
inline

write binary payload content; the data written is not copied, and therefore must persist until the message has finished sending

Parameters
datapoints to the binary data to append to the payload content
lengththe length, in bytes, of the binary data

Definition at line 146 of file HTTPWriter.hpp.


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