GPSReceiverConnectionPolicy.h

Go to the documentation of this file.

#pragma once
 
#include <chrono>
#include <optional>
 
#include <QtCore/QCoreApplication>
#include <QtCore/QString>
 
#include "ExponentialBackoff.h"
#include "GPSReceiverConnector.h"
#ifndef QGC_NO_SERIAL_LINK
#include "SerialPortManager.h"
#endif
 
class RuntimeScheduler;
 
enum class GPSReceiverSessionOutcome
{
    None,
    Unplugged,
    AutoRetrying,
    WaitingForPort,
    Retrying,
};
 
class GPSReceiverConnectionPolicy
{
    Q_DECLARE_TR_FUNCTIONS(GPSReceiverConnectionPolicy)
 
    friend class GPSReceiverConnectionPolicyTest;
 
public:
    GPSReceiverConnectionPolicy(GPSReceiverConnector& receiver, const GPSReceiverConfiguration& configuration,
                                RuntimeScheduler* scheduler);
 
    void configurationChanged(const GPSReceiverConfiguration& previous);
 
    bool connectConfigured(bool allowPersistentChanges);
    void disconnectConfigured();
    void update();
    void reset();
 
    bool reconnecting() const { return _keepConnected && !_receiver.hasReceiver(); }
 
    void receiverReady();
    [[nodiscard]] GPSReceiverSessionOutcome sessionEnded(bool portRemoved);
 
private:
    enum class Owner
    {
        None,
        Saved,
        Discovered,
    };
 
    bool _hasSavedReceiver() const;
    bool _discoveryEnabled() const;
    bool _connectConfigured(bool allowPersistentChanges);
    void _updateSaved();
    void _attemptSaved();
    void _scheduleRetry();
    void _cancelRetries();
    bool _serialDeviceAvailable(const QString& device) const;
    void _updateDiscovery();
#ifndef QGC_NO_SERIAL_LINK
    void _connectDiscovered(const QString& device);
#endif
 
    GPSReceiverConnector& _receiver;
    const GPSReceiverConfiguration& _configuration;
    RuntimeScheduler* const _scheduler;
    Owner _owner = Owner::None;
    bool _startPending = true;
    bool _keepConnected = false;
    bool _paused = false;
    bool _waitingForPort = false;
    QString _autoPort;
#ifndef QGC_NO_SERIAL_LINK
    SerialPortSettleTracker _waitingPorts;
#endif
    std::optional<quint64> _retryDeadlineUs;
    ExponentialBackoff _retryBackoff{std::chrono::seconds(1), 2, std::chrono::seconds(30)};
};