rs_rum.h File Reference

Exposes RUM (Real User Monitoring) functionality for C compilers. More...

#include "rs_types.h"

Go to the source code of this file.

Functions
const rs2_raw_data_buffer *	rs2_rum_get_report_path (rs2_error **error)
void	rs2_rum_set_cloud_enabled (int enabled, rs2_error **error)
int	rs2_rum_is_cloud_enabled (rs2_error **error)

Detailed Description

Exposes RUM (Real User Monitoring) functionality for C compilers.

RUM collects anonymous, aggregated SDK usage statistics locally. Data only leaves the machine when the user explicitly opts in to cloud upload. These entry points are always compiled and functional: rs2_rum_get_report_path returns the path of the on-disk report file (SDK/system metadata plus whatever has been collected) and the consent get/set always read and write the per-user config file. The ENABLE_STATS build option (default ON) gates only the instrumentation hooks that feed the collector; when it is off the report's collected lists (devices, streams, filters, options, notifications) stay empty, but the API itself behaves identically.

Function Documentation

rs2_rum_get_report_path()

const rs2_raw_data_buffer* rs2_rum_get_report_path

(

rs2_error **

error

)

Retrieve the path of the on-disk RUM report file (in the app-data folder). The SDK writes the accumulated report there when a context is destroyed; read that file to inspect or upload it. No upload is performed.

Parameters

[out]

error

If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns

A raw-data buffer holding the UTF-8 file path; release with rs2_delete_raw_data

rs2_rum_is_cloud_enabled()

int rs2_rum_is_cloud_enabled

(

rs2_error **

error

)

Query the resolved cloud-upload consent (RS2_RUM_CLOUD_ENABLED env var overrides the config file).

Parameters

[out]

error

If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns

Non-zero if cloud upload is enabled, zero otherwise

rs2_rum_set_cloud_enabled()

void rs2_rum_set_cloud_enabled	(	int	enabled,
		rs2_error **	error
	)

Set the cloud-upload consent flag. Persists to the per-user configuration file.

Parameters

[in]	enabled	Non-zero to opt in to cloud upload, zero to opt out
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored