GPSTransport.h

Go to the documentation of this file.

#pragma once
 
#include <chrono>
#include <cstdint>
#include <span>
 
#include <QtCore/QByteArrayView>
#include <QtCore/QDeadlineTimer>
#include <QtCore/QString>
 
#include "GPSCancellation.h"
 
enum class GPSOpenStatus
{
    Opened,
    TimedOut,
    Cancelled,
    Error,
    Unsupported
};
 
enum class GPSReadStatus
{
    Data,
    TimedOut,
    Cancelled,
    Closed,
    Error,
    Overflow
};
 
enum class GPSWriteStatus
{
    Completed,
    TimedOut,
    Cancelled,
    Error,
    Unsupported
};
 
struct [[nodiscard]] GPSOpenResult
{
    GPSOpenStatus status = GPSOpenStatus::Unsupported;
    QString detail = {};
};
 
struct [[nodiscard]] GPSReadResult
{
    GPSReadStatus status = GPSReadStatus::TimedOut;
    int bytesRead = 0;
    QString detail = {};
};
 
struct [[nodiscard]] GPSWriteResult
{
    GPSWriteStatus status = GPSWriteStatus::Unsupported;
    int acceptedBytes = 0;
    int writtenBytes = 0;
    QString detail = {};
 
    [[nodiscard]] int uncertainBytes() const
    {
        return acceptedBytes >= 0 && writtenBytes >= 0 && writtenBytes <= acceptedBytes ? acceptedBytes - writtenBytes
                                                                                        : -1;
    }
};
 
class GPSTransport
{
public:
    explicit GPSTransport(GPSCancelToken cancelToken);
    virtual ~GPSTransport();
 
    virtual GPSOpenResult open() = 0;
    virtual bool fatalError() const = 0;
 
    bool isCancelled() const { return _cancelToken.isCancelled(); }
 
    const GPSCancelToken& cancelToken() const { return _cancelToken; }
 
    virtual unsigned fixedBaudrate() const { return 0; }
 
    static constexpr unsigned BRIDGE_BAUDRATE = 115200;
    static constexpr qint64 READ_BUFFER_BYTES = 64 * 1024;
    static constexpr qint64 WRITE_BUFFER_BYTES = 4 * 1024;
 
    virtual GPSReadResult read(std::span<uint8_t> buffer, std::chrono::milliseconds timeout) = 0;
 
    virtual std::chrono::milliseconds configurationWriteTimeout() const;
 
    GPSWriteResult write(QByteArrayView bytes, QDeadlineTimer deadline);
 
    virtual bool setBaudrate(unsigned baudrate);
 
protected:
    virtual GPSWriteResult writeData(QByteArrayView bytes, QDeadlineTimer deadline) = 0;
 
private:
    GPSCancelToken _cancelToken;
};