NTRIPHttpCodec.h

Go to the documentation of this file.

#pragma once
 
#include <optional>
 
#include <QtCore/QByteArray>
#include <QtCore/QByteArrayView>
#include <QtCore/QDateTime>
#include <QtCore/QString>
#include <QtNetwork/QHttpHeaders>
 
#include "NTRIPError.h"
 
struct NTRIPConnectionConfig;
 
enum class NTRIPHttpPurpose
{
    Corrections,
    SourceTable,
};
 
struct NTRIPHttpRequest
{
    QByteArray bytes;
    QString error;
 
    [[nodiscard]] static NTRIPHttpRequest build(const NTRIPConnectionConfig& config,
                                                NTRIPHttpPurpose purpose = NTRIPHttpPurpose::Corrections);
};
 
class NTRIPHttpDecoder
{
public:
    explicit NTRIPHttpDecoder(NTRIPHttpPurpose purpose = NTRIPHttpPurpose::Corrections)
        : _purpose(purpose)
    {}
 
    static constexpr qsizetype MAX_HEADER_BYTES = 32768;
    static constexpr qsizetype MAX_LINE_BYTES = 8192;
    static constexpr quint64 MAX_CHUNK_BYTES = 16 * 1024 * 1024;
    static constexpr qsizetype MAX_ERROR_BODY_BYTES = 500;
    static constexpr qsizetype MAX_ERROR_PREVIEW_CHARS = 200;
 
    struct [[nodiscard]] Status
    {
        int code = 0;
        QString reason;
        bool valid = false;
    };
 
    struct [[nodiscard]] Result
    {
        QByteArray body;  
        bool connected = false;
        bool complete = false;
        std::optional<NTRIPFailure> failure;
    };
 
    void reset();
    Result feed(QByteArrayView bytes, const QDateTime& utcNow);
    Result finish();
 
    bool awaitingErrorBody() const { return _pendingFailure.has_value(); }
 
    static Status parseStatusLine(QByteArrayView line);
 
private:
    enum class State
    {
        Status,
        Headers,
        IcyHeaders,
        Identity,
        ChunkSize,
        ChunkData,
        ChunkEnd,
        Trailers,
        Complete,
        Failed
    };
 
    void _lineReceived(Result& result, const QDateTime& utcNow);
    void _beginBody(Result& result);
    void _beginIcyBody(Result& result);
    void _finishError(Result& result);
    void _fail(Result& result, const QString& detail, NTRIPError code = NTRIPError::InvalidHttpResponse);
 
    QHttpHeaders _headers;
    NTRIPHttpPurpose _purpose;
    State _state = State::Status;
    QByteArray _line;
    Status _status;
    qsizetype _headerBytes = 0;
    quint64 _remaining = 0;
    int _chunkEndBytes = 0;
    int _informationalResponses = 0;
    bool _http10 = false;
    bool _chunked = false;
    std::optional<quint64> _contentLength;
    std::optional<NTRIPFailure> _pendingFailure;
    QByteArray _errorBody;
};