enginerequest.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: (C) 2017-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef ENGINEREQUEST_H
#define ENGINEREQUEST_H

#include <Cutelyst/Headers>

#include <QElapsedTimer>
#include <QHostAddress>
#include <QObject>

namespace Cutelyst {

class Engine;
class Context;
class CUTELYST_LIBRARY EngineRequest
{
    Q_GADGET
    friend class Engine;

public:
    enum StatusFlag {
        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 QString &key, const QString &origin, const QString &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 QString &key, const QString &origin, const QString &protocol);

public:
    void setPath(char *rawPath, const int len);

    inline void setPath(const QString &path)
    {
        QByteArray rawPath = path.toLatin1();
        setPath(rawPath.data(), rawPath.size());
    }

    QString method;

    QString path;

    QByteArray query;

    QString protocol;

    QString serverAddress;

    QHostAddress remoteAddress;

    QString remoteUser;

    Headers headers;

    quint64 startOfRequest = 0;

    Status status = InitialState;

    QIODevice *body = nullptr;

    Context *context = nullptr;

    quint16 remotePort = 0;

    bool isSecure = false;

    QElapsedTimer elapsed;
};

} // namespace Cutelyst

Q_DECLARE_OPERATORS_FOR_FLAGS(Cutelyst::EngineRequest::Status)

#endif // ENGINEREQUEST_H