Listener for the event of sending a telemetry event. More...

#include <ITelemetry.h>

Inheritance diagram for ITelemetryEventSendListener:

Public Types
enum	FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_CLIENT_FORBIDDEN , FAILURE_REASON_INVALID_DATA , FAILURE_REASON_CONNECTION_FAILURE , FAILURE_REASON_NO_SAMPLING_CLASS_IN_CONFIG , FAILURE_REASON_SAMPLING_CLASS_FIELD_MISSING , FAILURE_REASON_EVENT_SAMPLED_OUT , FAILURE_REASON_SAMPLING_RESULT_ALREADY_EXIST , FAILURE_REASON_SAMPLING_INVALID_RESULT_PATH }
	The reason of a failure in sending a telemetry event. More...

Public Member Functions
virtual void	OnTelemetryEventSendSuccess (const char *eventType, uint32_t sentEventIndex)=0
	Notification for the event of sending a telemetry event. More...

virtual void	OnTelemetryEventSendFailure (const char *eventType, uint32_t sentEventIndex, FailureReason failureReason)=0
	Notification for the event of a failure in sending a telemetry event. More...

Additional Inherited Members
Static Public Member Functions inherited from GalaxyTypeAwareListener< TELEMETRY_EVENT_SEND_LISTENER >
static ListenerType	GetListenerType ()
	Returns the type of the listener. More...

Detailed Description

Listener for the event of sending a telemetry event.

Member Enumeration Documentation

The reason of a failure in sending a telemetry event.

Enumerator
FAILURE_REASON_UNDEFINED	Unspecified error.
FAILURE_REASON_CLIENT_FORBIDDEN	Sending telemetry events is forbidden for this application.
FAILURE_REASON_INVALID_DATA	The event of given type and form does not match specification.
FAILURE_REASON_CONNECTION_FAILURE	Unable to communicate with backend services.
FAILURE_REASON_NO_SAMPLING_CLASS_IN_CONFIG	The event sampling class not present in configuration.
FAILURE_REASON_SAMPLING_CLASS_FIELD_MISSING	Sampling class' field not present in the event.
FAILURE_REASON_EVENT_SAMPLED_OUT	The event did not match sampling criteria.
FAILURE_REASON_SAMPLING_RESULT_ALREADY_EXIST	The event already contains a field defined as "dry_run_result_path".
FAILURE_REASON_SAMPLING_INVALID_RESULT_PATH	"dry_run_result_path" has an invalid value (doesn't start with "data" or "meta" or one of the intermediate elements isn't an object).

virtual void OnTelemetryEventSendFailure	(	const char *	eventType,
		uint32_t	sentEventIndex,
		FailureReason	failureReason
	)

pure virtual

Notification for the event of a failure in sending a telemetry event.

Parameters

[in]	eventType	The type of the event.
[in]	sentEventIndex	The internal index of the sent event.
[in]	failureReason	The cause of the failure.

virtual void OnTelemetryEventSendSuccess	(	const char *	eventType,
		uint32_t	sentEventIndex
	)

pure virtual

Notification for the event of sending a telemetry event.

Parameters

[in]	eventType	The type of the event.
[in]	sentEventIndex	The internal index of the sent event.