bluetooth_scanner_configuration.hpp

Go to the documentation of this file.

#ifndef BLUETOOTH_SCANNER_CONFIGURATION_HPP_
#define BLUETOOTH_SCANNER_CONFIGURATION_HPP_

#include <string>
#include <memory>
#include <chrono>

namespace kallisto {
namespace bluetooth {

#define MAX_DURATION std::chrono::seconds(60)

#define MAX_CYCLE_DURATION std::chrono::seconds(3600)

//Helper variables for scan duration
#define SHORT_SCAN std::chrono::seconds(5)

#define MEDIUM_SCAN std::chrono::seconds(10)

#define LONG_SCAN std::chrono::seconds(20)

//Helper variables for scanner configuration
#define RESPONSIVE_SCANNER std::chrono::seconds(5)

#define BALANCED_SCANNER std::chrono::seconds(15)

#define LOW_POWER_SCANNER std::chrono::seconds(60)

class BluetoothScannerConfiguration {
public:
    class Builder;
    friend class Builder;

    enum class ScanConfiguration {
        ONE_SHOT,
        CYCLIC,
        CONTINUOUS,
        STOPPED
    };

private:
    ScanConfiguration m_scan_configuration; //Configuration

    std::chrono::seconds m_duration; //Scan duration, in seconds

    std::chrono::seconds m_cycle_duration; //Time variable for cyclic scanner, in seconds. Will only be used in CYCLIC configuration

    bool m_legacy_discovery; //If we should fallback to legacy discovery if device is not using Scan Response advertising

    BluetoothScannerConfiguration(ScanConfiguration scan_configuration, std::chrono::seconds scan_duration, std::chrono::seconds cycle_duration, bool legacy_discovery);

public:
    ~BluetoothScannerConfiguration();

    BluetoothScannerConfiguration(const BluetoothScannerConfiguration& configuration);

    BluetoothScannerConfiguration& operator=(const BluetoothScannerConfiguration& configuration);

    BluetoothScannerConfiguration(BluetoothScannerConfiguration&& configuration);

    BluetoothScannerConfiguration& operator=(BluetoothScannerConfiguration&& configuration);

    ScanConfiguration getScanConfiguration() const;

    std::chrono::seconds getDuration() const;

    std::chrono::seconds getCycleDuration() const;

    bool getLegacyDiscovery() const;

    class Builder {
    private:
        ScanConfiguration m_scan_configuration = ScanConfiguration::CYCLIC;

        bool m_configuration_explicit = false; //Signals if the dev forced the scan type

        std::chrono::seconds m_duration = std::chrono::seconds(0); //Scan duration

        std::chrono::seconds m_cycle_duration = std::chrono::seconds(0); //Time variable for cyclic scanner. Will only be used in CYCLIC configuration

        bool m_legacy_discovery = false; //If we should fallback to legacy discovery if device is not using Scan Response advertising

        Builder(Builder const&) = delete;
        Builder(Builder&&) = delete;
        void operator=(Builder const&) = delete;
        void operator=(Builder &&) = delete;

    public:
        Builder();

        ~Builder();

        Builder& continuous();

        Builder& stop();

        Builder& withDuration(std::chrono::seconds duration);

        Builder& withShortDuration();

        Builder& withMediumDuration();

        Builder& withLongDuration();

        Builder& withCycle(std::chrono::seconds cycle_time);

        Builder& withResponsiveCycle();

        Builder& withBalancedCycle();

        Builder& withLowPowerCycle();

        Builder& withLegacyDiscoveryFallback();

        BluetoothScannerConfiguration build();

        BluetoothScannerConfiguration buildDefault();
    };
};

} /* namespace bluetooth */
} /* namespace kallisto */

#endif /* BLUETOOTH_SCANNER_CONFIGURATION_HPP_ */