xbmc/pvr/addons/PVRClientUID.h

   1 /*
   2  *  Copyright (C) 2012-2022 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "addons/IAddon.h"
  12
  13 #include <string>
  14
  15 namespace PVR
  16 {
  17 class CPVRClientUID final
  18 {
  19 public:
  20   CPVRClientUID(const std::string& addonID, ADDON::AddonInstanceId instanceID)
  21     : m_addonID(addonID), m_instanceID(instanceID)
  22   {
  23   }
  24
  25   virtual ~CPVRClientUID() = default;
  26
  27   /*!
  28    * @brief Return the numeric UID.
  29    * @return The numeric UID, or PVR_CLIENT_INVALID_UID on error.
  30    */
  31   int GetUID() const;
  32
  33   /*!
  34    * @brief Return the numeric legacy UID (compatibility/migration purposes only).
  35    * @return The numeric legacy UID.
  36    */
  37   int GetLegacyUID() const;
  38
  39 private:
  40   CPVRClientUID() = delete;
  41
  42   std::string m_addonID;
  43   ADDON::AddonInstanceId m_instanceID{ADDON::ADDON_SINGLETON_INSTANCE_ID};
  44
  45   mutable bool m_uidCreated{false};
  46   mutable int m_uid{0};
  47 };
  48 } // namespace PVR