src/network/network_survey.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file network_survey.h Part of the network protocol handling opt-in survey. */
   9
  10 #ifndef NETWORK_SURVEY_H
  11 #define NETWORK_SURVEY_H
  12
  13 #include <condition_variable>
  14 #include <mutex>
  15 #include "core/http.h"
  16
  17 /**
  18  * Socket handler for the survey connection
  19  */
  20 class NetworkSurveyHandler : public HTTPCallback {
  21 protected:
  22         void OnFailure() override;
  23         void OnReceiveData(std::unique_ptr<char[]> data, size_t length) override;
  24         bool IsCancelled() const override { return false; }
  25
  26 public:
  27         enum class Reason {
  28                 PREVIEW, ///< User is previewing the survey result.
  29                 LEAVE, ///< User is leaving the game (but not exiting the application).
  30                 EXIT, ///< User is exiting the application.
  31                 CRASH, ///< Game crashed.
  32         };
  33
  34         void Transmit(Reason reason, bool blocking = false);
  35         std::string CreatePayload(Reason reason, bool for_preview = false);
  36
  37         constexpr static bool IsSurveyPossible()
  38         {
  39                 return true;
  40         }
  41
  42 private:
  43         std::mutex mutex; ///< Mutex for the condition variable.
  44         std::atomic<bool> transmitted; ///< Whether the survey has been transmitted.
  45         std::condition_variable transmitted_cv; ///< Condition variable to inform changes to transmitted.
  46 };
  47
  48 extern NetworkSurveyHandler _survey;
  49
  50 #endif /* NETWORK_SURVEY_H */