qhttpserverresponse.hpp

/** HTTP response from a server.
 * https://github.com/azadkuh/qhttp
 *
 * @author amir zamani
 * @version 2.0.0
 * @date 2014-07-11
  */

#ifndef QHTTPSERVER_RESPONSE_HPP
#define QHTTPSERVER_RESPONSE_HPP

///////////////////////////////////////////////////////////////////////////////

#include "qhttpabstracts.hpp"

///////////////////////////////////////////////////////////////////////////////
namespace qhttp {
namespace server {
///////////////////////////////////////////////////////////////////////////////
/** The QHttpResponse class handles sending data back to the client as a response to a request.
 * @sa QHttpConnection
 */
class QHttpResponse : public QHttpAbstractOutput
{
    Q_OBJECT

public:
    virtual        ~QHttpResponse();

public:
    /** set the response HTTP status code. @sa TStatusCode.
     * default value is ESTATUS_BAD_REQUEST.
     * @sa write()
     */
    void            setStatusCode(TStatusCode code);

public: // QHttpAbstractOutput methods:
    /** @see QHttpAbstractOutput::setVersion(). */
    void            setVersion(const QString& versionString) override;

    /** @see QHttpAbstractOutput::addHeader(). */
    void            addHeader(const QByteArray& field, const QByteArray& value) override;

    /** @see QHttpAbstractOutput::headers(). */
    THeaderHash&    headers() override;

    /** @see QHttpAbstractOutput::write(). */
    void            write(const QByteArray &data) override;

    /** @see QHttpAbstractOutput::end(). */
    void            end(const QByteArray &data = QByteArray()) override;

public:
    /** returns the parent QHttpConnection object. */
    QHttpConnection* connection() const;

protected:
    explicit        QHttpResponse(QHttpConnection*);
    explicit        QHttpResponse(QHttpResponsePrivate&, QHttpConnection*);
    friend class    QHttpConnectionPrivate;

    Q_DECLARE_PRIVATE(QHttpResponse)
    QScopedPointer<QHttpResponsePrivate> d_ptr;
};

///////////////////////////////////////////////////////////////////////////////
} // namespace server
} // namespace qhttp
///////////////////////////////////////////////////////////////////////////////
#endif // define QHTTPSERVER_RESPONSE_HPP