host_records.h

Go to the documentation of this file.

 
#pragma once
 
// standard includes
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
 
namespace app {
 
  inline constexpr uint16_t DEFAULT_HOST_PORT = 47989;  
 
  enum class PairingState {
    not_paired,  
    paired,  
  };
 
  enum class HostReachability {
    unknown,  
    online,  
    offline,  
  };
 
  enum class HostAppListState {
    idle,  
    loading,  
    ready,  
    failed,  
  };
 
  struct HostAppRecord {
    std::string name;  
    int id = 0;  
    bool hdrSupported = false;  
    bool hidden = false;  
    bool favorite = false;  
    std::string boxArtCacheKey;  
    bool boxArtCached = false;  
    bool running = false;  
  };
 
  struct HostRecord {
    std::string displayName;  
    std::string address;  
    uint16_t port = 0;  
    PairingState pairingState = PairingState::not_paired;  
    HostReachability reachability = HostReachability::unknown;  
    std::string activeAddress;  
    std::string uuid;  
    std::string localAddress;  
    std::string remoteAddress;  
    std::string ipv6Address;  
    std::string manualAddress;  
    std::string macAddress;  
    uint16_t httpsPort = 0;  
    uint32_t runningGameId = 0;  
    std::vector<HostAppRecord> apps;  
    HostAppListState appListState = HostAppListState::idle;  
    std::string appListStatusMessage;  
    uint16_t resolvedHttpPort = 0;  
    uint64_t appListContentHash = 0;  
    uint32_t lastAppListRefreshTick = 0;  
  };
 
  struct ParseHostRecordsResult {
    std::vector<HostRecord> records;  
    std::vector<std::string> errors;  
  };
 
  const char *to_string(PairingState pairingState);
 
  const char *to_string(HostReachability reachability);
 
  std::string normalize_ipv4_address(std::string_view address);
 
  bool is_valid_ipv4_address(std::string_view address);
 
  std::string build_default_host_display_name(std::string_view normalizedAddress);
 
  uint16_t effective_host_port(uint16_t port);
 
  bool try_parse_host_port(std::string_view portText, uint16_t *parsedPort);
 
  bool contains_host_address(const std::vector<HostRecord> &records, std::string_view normalizedAddress, uint16_t port = 0);
 
  bool host_matches_endpoint(const HostRecord &host, std::string_view normalizedAddress, uint16_t port);
 
  bool validate_host_record(const HostRecord &record, std::string *errorMessage = nullptr);
 
  std::string serialize_host_records(const std::vector<HostRecord> &records);
 
  ParseHostRecordsResult parse_host_records(std::string_view serializedRecords);
 
}  // namespace app