Client Metric API Reference

INTERNAL USE ONLY. This module is for internal use only, you should not use it in game.

API List

API	Description
ReportMetric	Report a metric event
Flush	Flush all metric data in queue

API Details

ReportMetric

Report a metric event

/**
 * Report a metric event
 * 
 * @param metric_name An unique name for reported event
 * @param data Key-value pairs that store the metric data
 */
void ReportMetric(
    const pgos::pstring& metric_name,
    const pgos::pmap<pgos::pstring, KVDataValue>& data);

Parameters:

Param	Type	Description
metric_name	const std::string&	An unique name for reported event
data	const std::map<std::string, KVDataValue>&	Key-value pairs that store the metric data

Return: void

Flush

Flush all metric data in queue

/**
 * Flush all metric data in queue
 */
void Flush();

Parameters:

(No parameters)

Return: void