File: UserReport.h

package info (click to toggle)
0ad 0.0.17-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 51,248 kB
  • ctags: 46,933
  • sloc: cpp: 223,208; ansic: 31,240; python: 16,343; perl: 4,083; sh: 1,011; makefile: 915; xml: 733; java: 621; ruby: 229; erlang: 53; sql: 40
file content (62 lines) | stat: -rw-r--r-- 1,941 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/* Copyright (C) 2011 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. 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, either version 2 of the License, or
 * (at your option) any later version.
 *
 * 0 A.D. 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.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef INCLUDED_USERREPORT
#define INCLUDED_USERREPORT

class CUserReporterWorker;

class CUserReporter
{
public:
	CUserReporter();
	~CUserReporter();

	void Initialize();
	void Deinitialize();

	/**
	 * Must be called frequently (preferably every frame), to update some
	 * internal reconnection timers.
	 */
	void Update();

	// Functions for the GUI to control the reporting:
	bool IsReportingEnabled();
	void SetReportingEnabled(bool enabled);
	std::string GetStatus();

	/**
	 * Submit a report to be transmitted to the online server.
	 * Nothing will be transmitted until reporting is enabled by the user, so
	 * you don't need to check for that first.
	 * @param type short string identifying the type of data ("hwdetect", "message", etc)
	 * @param version positive integer that should be incremented if the data is changed in
	 * a non-compatible way and the server will have to distinguish old and new formats
	 * @param data the actual data (typically UTF-8-encoded text, or JSON, but could be binary)
	 */
	void SubmitReport(const char* type, int version, const std::string& data);

private:
	std::string LoadUserID();

	CUserReporterWorker* m_Worker;
};

extern CUserReporter g_UserReporter;

#endif // INCLUDED_USERREPORT