Template Struct Telemetry

• Defined in File Telemetry.hpp

Struct Documentation

template<typename TLogger = Logging::DefaultLogger<>>
struct Microsoft::XboxStudios::Heimdall::Telemetry

Telemetry events invoked by HeimdallPoller for logging.

tparam TLogger

The logger to use. TLogger must implement a static LogLine method. See DefaultLogger::LogLine for reference.

Public Static Functions

static inline void OnStopPollStarted(const Listener &listener, const tl::optional<AutoGeneratedKey> &serviceKey)

Invoked before the poller attempts to remove the Listener.

Parameters

• listener – The Listener to be removed.

• serviceKey – The key returned by the service when the Listener was added to the service.

static inline void OnListenerRemoved(const Listener &listener, const tl::optional<HeimdallServiceError> &removeResult)

Invoked when the poller removes a Listener successfully.

Parameters

• listener – The Listener that was removed.

• error – The error the remove operation failed with.

static inline void OnAddListenerFailed(const HeimdallServiceError &error)

Invoked when the poller failed to add the Listener due to a service error.

Parameters

error – The error the add operation failed with.

static inline void OnHeimdallPollingTerminating()

Invoked when the poller terminates due to either a fatal service error when adding the Listener or because the user requested it.

static inline void OnAddListenerStarted(const ListenerState &listener)

Invoked when the poller is adding its Listener to the service.

Parameters

listener – The Listener about to get added.

static inline void OnConnectionToSenderStarted(const Endpoint &ep)

Invoked when a callback by a sender has been requested.

Parameters

ep – The Endpoint of the sender.

static inline void OnConnectionToSenderFinished(const Endpoint &ep, const tl::optional<ConnectionToSenderError> &error)

Invoked when the tool attempted to connect to a sender.

Parameters

• ep – The Endpoint of the sender that the tool attempted to connect with.

• error – The error the connection failed with if any.