enginerequest.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: (C) 2017-2023 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#pragma once
 
#include <Cutelyst/Headers>
#include <chrono>
 
#include <QElapsedTimer>
#include <QHostAddress>
#include <QObject>
 
namespace Cutelyst {
 
using TimePointSteady = std::chrono::time_point<std::chrono::steady_clock>;
 
class Engine;
class Context;
class CUTELYST_EXPORT EngineRequest
{
    Q_GADGET
    friend class Engine;
 
public:
    enum StatusFlag : quint8 {
        InitialState     = 0x00,
        FinalizedHeaders = 0x01,
        IOWrite          = 0x02,
        Chunked          = 0x04,
        ChunkedDone      = 0x08,
        Async            = 0x10,
        Finalized        = 0x20,
    };
    Q_DECLARE_FLAGS(Status, StatusFlag)
 
    explicit EngineRequest();
 
    virtual ~EngineRequest();

    virtual void finalizeBody();

    virtual void finalizeError();

    void finalize();

    virtual void finalizeCookies();

    virtual bool finalizeHeaders();

    qint64 write(const char *data, qint64 len);
 
    bool webSocketHandshake(const QByteArray &key,
                            const QByteArray &origin,
                            const QByteArray &protocol);
 
    virtual bool webSocketSendTextMessage(const QString &message);
 
    virtual bool webSocketSendBinaryMessage(const QByteArray &message);
 
    virtual bool webSocketSendPing(const QByteArray &payload);
 
    virtual bool webSocketClose(quint16 code, const QString &reason);
 
protected:
    virtual qint64 doWrite(const char *data, qint64 len) = 0;

    virtual void processingFinished();

    virtual bool writeHeaders(quint16 status, const Headers &headers) = 0;
 
    virtual bool webSocketHandshakeDo(const QByteArray &key,
                                      const QByteArray &origin,
                                      const QByteArray &protocol);
 
public:
    void setPath(char *rawPath, int len);
 
    void setPath(QByteArray &path)
    {
        Q_ASSERT_X(path.startsWith('/'), "leading slash", "Path must always start with /");
        setPath(path.data(), path.size());
    }

    QByteArray method;

    QString path;

    QByteArray query;

    QByteArray protocol;

    QByteArray serverAddress;

    QHostAddress remoteAddress;

    QString remoteUser;

    Headers headers;

    QIODevice *body = nullptr;

    Context *context = nullptr;

    TimePointSteady startOfRequest;

    quint16 remotePort = 0;

    Status status = InitialState;

    bool isSecure = false;
};
 
} // namespace Cutelyst
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Cutelyst::EngineRequest::Status)