httpresponse.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_HTTP
#include <functional>
#include <promeki/function.h>
#include <promeki/namespace.h>
#include <promeki/string.h>
#include <promeki/buffer.h>
#include <promeki/sharedptr.h>
#include <promeki/list.h>
#include <promeki/iodevice.h>
#include <promeki/httpstatus.h>
#include <promeki/httpheaders.h>
#include <promeki/json.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class TcpSocket;
 
class HttpResponse {
                PROMEKI_SHARED_FINAL(HttpResponse)
        public:
                using Ptr = SharedPtr<HttpResponse>;
 
                using List = ::promeki::List<HttpResponse>;
 
                using PtrList = ::promeki::List<Ptr>;
 
                static const String DefaultHttpVersion;
 
                HttpResponse() = default;
 
                const HttpStatus &status() const { return _status; }
 
                void setStatus(const HttpStatus &s) {
                        _status = s;
                        _customReason.clear();
                }
 
                void setStatus(int code) {
                        _status = HttpStatus{code};
                        _customReason.clear();
                }
 
                String reasonPhrase() const;
 
                void setReasonPhrase(const String &s) { _customReason = s; }
 
                const HttpHeaders &headers() const { return _headers; }
 
                HttpHeaders &headers() { return _headers; }
 
                void setHeaders(const HttpHeaders &h) { _headers = h; }
 
                void setHeader(const String &name, const String &value) { _headers.set(name, value); }
 
                void addHeader(const String &name, const String &value) { _headers.add(name, value); }
 
                const Buffer &body() const { return _body; }
 
                bool hasBodyStream() const { return _bodyStream.isValid(); }
 
                IODevice *bodyStream() const {
                        return _bodyStream.isValid() ? const_cast<IODevice *>(_bodyStream.ptr()) : nullptr;
                }
 
                const IODevice::Shared &bodyStreamShared() const { return _bodyStream; }
 
                int64_t bodyStreamLength() const { return _bodyStreamLength; }
 
                IODevice::Shared takeBodyStream();
 
                void setBody(const Buffer &body);
 
                void setBody(const String &text);
 
                void setText(const String &text);
 
                void setHtml(const String &html);
 
                void setBinary(const Buffer &body, const String &mimeType);
 
                void setJson(const JsonObject &obj);
 
                void setJson(const JsonArray &arr);
 
                void setJsonPretty(const JsonObject &obj, unsigned int indent = 2);
 
                void setJsonPretty(const JsonArray &arr, unsigned int indent = 2);
 
                void setBodyStream(IODevice::Shared device, int64_t length = -1, const String &mimeType = String());
 
                bool isSuccess() const { return _status.isSuccess(); }
                bool isRedirect() const { return _status.isRedirect(); }
                bool isError() const { return _status.isError(); }
 
                const String &httpVersion() const { return _httpVersion; }
 
                void setHttpVersion(const String &v) { _httpVersion = v; }
 
                // ============================================================
                // Convenience factories
                // ============================================================
 
                static HttpResponse ok(const JsonObject &obj);
 
                static HttpResponse ok(const String &text);
 
                static HttpResponse notFound(const String &message = String());
 
                static HttpResponse badRequest(const String &message = String());
 
                static HttpResponse methodNotAllowed(const String &allow);
 
                static HttpResponse internalError(const String &message = String());
 
                static HttpResponse noContent();
 
                // ============================================================
                // Protocol upgrade hook
                // ============================================================
 
                using UpgradeHook = Function<void(TcpSocket *socket)>;
 
                void setUpgradeHook(UpgradeHook hook) { _upgradeHook = std::move(hook); }
 
                const UpgradeHook &upgradeHook() const { return _upgradeHook; }
 
        private:
                HttpStatus       _status = HttpStatus::Ok;
                String           _customReason;
                HttpHeaders      _headers;
                Buffer           _body;
                IODevice::Shared _bodyStream;
                int64_t          _bodyStreamLength = -1;
                String           _httpVersion = DefaultHttpVersion;
                UpgradeHook      _upgradeHook;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_HTTP