Pyrogenesis  13997
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CUserReporter Class Reference

#include <UserReport.h>

Public Member Functions

 CUserReporter ()
 
 ~CUserReporter ()
 
void Initialize ()
 
void Deinitialize ()
 
void Update ()
 Must be called frequently (preferably every frame), to update some internal reconnection timers. More...
 
bool IsReportingEnabled ()
 
void SetReportingEnabled (bool enabled)
 
std::string GetStatus ()
 
void SubmitReport (const char *type, int version, const std::string &data)
 Submit a report to be transmitted to the online server. More...
 

Private Member Functions

std::string LoadUserID ()
 

Private Attributes

CUserReporterWorkerm_Worker
 

Detailed Description

Definition at line 23 of file UserReport.h.

Constructor & Destructor Documentation

CUserReporter::CUserReporter ( )

Definition at line 508 of file UserReport.cpp.

CUserReporter::~CUserReporter ( )

Definition at line 513 of file UserReport.cpp.

Member Function Documentation

void CUserReporter::Deinitialize ( )

Definition at line 590 of file UserReport.cpp.

std::string CUserReporter::GetStatus ( )

Definition at line 564 of file UserReport.cpp.

void CUserReporter::Initialize ( )

Definition at line 573 of file UserReport.cpp.

bool CUserReporter::IsReportingEnabled ( )

Definition at line 547 of file UserReport.cpp.

std::string CUserReporter::LoadUserID ( )
private

Definition at line 518 of file UserReport.cpp.

void CUserReporter::SetReportingEnabled ( bool  enabled)

Definition at line 554 of file UserReport.cpp.

void CUserReporter::SubmitReport ( const char *  type,
int  version,
const std::string &  data 
)

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.

Parameters
typeshort string identifying the type of data ("hwdetect", "message", etc)
versionpositive 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
datathe actual data (typically UTF-8-encoded text, or JSON, but could be binary)

Definition at line 616 of file UserReport.cpp.

void CUserReporter::Update ( )

Must be called frequently (preferably every frame), to update some internal reconnection timers.

Definition at line 610 of file UserReport.cpp.

Member Data Documentation

CUserReporterWorker* CUserReporter::m_Worker
private

Definition at line 57 of file UserReport.h.


The documentation for this class was generated from the following files: