host_probe_result_queue.h

Go to the documentation of this file.

 
#pragma once
 
// standard includes
#include <cstddef>
#include <cstdint>
#include <mutex>
#include <string>
#include <vector>
 
// local includes
#include "src/network/host_pairing.h"
 
namespace ui {
 
  struct HostProbeResult {
    std::string address;  
    uint16_t port = 0;  
    bool success = false;  
    network::HostPairingServerInfo serverInfo;  
  };
 
  class HostProbeResultQueue {
  public:
    HostProbeResultQueue() = default;
 
  private:
    friend void reset_host_probe_result_queue(HostProbeResultQueue *queue);
    friend void begin_host_probe_result_round(HostProbeResultQueue *queue, std::size_t targetCount);
    friend void publish_host_probe_result(HostProbeResultQueue *queue, HostProbeResult result);
    friend void skip_host_probe_result_target(HostProbeResultQueue *queue);
    friend std::vector<HostProbeResult> drain_host_probe_results(HostProbeResultQueue *queue);
    friend bool host_probe_result_round_complete(const HostProbeResultQueue &queue);
 
    mutable std::mutex mutex_;  
    std::size_t targetCount_ = 0U;  
    std::size_t publishedCount_ = 0U;  
    std::vector<HostProbeResult> pendingResults_;  
  };
 
  void reset_host_probe_result_queue(HostProbeResultQueue *queue);
 
  void begin_host_probe_result_round(HostProbeResultQueue *queue, std::size_t targetCount);
 
  void publish_host_probe_result(HostProbeResultQueue *queue, HostProbeResult result);
 
  void skip_host_probe_result_target(HostProbeResultQueue *queue);
 
  std::vector<HostProbeResult> drain_host_probe_results(HostProbeResultQueue *queue);
 
  bool host_probe_result_round_complete(const HostProbeResultQueue &queue);
 
}  // namespace ui