Pyrogenesis  trunk
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CUserReporter Class Reference

#include <UserReport.h>

Collaboration diagram for CUserReporter:
Collaboration graph
[legend]

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
 

Constructor & Destructor Documentation

CUserReporter::CUserReporter ( )
CUserReporter::~CUserReporter ( )

Member Function Documentation

void CUserReporter::Deinitialize ( )
std::string CUserReporter::GetStatus ( )
void CUserReporter::Initialize ( )
bool CUserReporter::IsReportingEnabled ( )
std::string CUserReporter::LoadUserID ( )
private
void CUserReporter::SetReportingEnabled ( bool  enabled)
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)
void CUserReporter::Update ( )

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

Member Data Documentation

CUserReporterWorker* CUserReporter::m_Worker
private

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