Class IDataViewerCollection

• Defined in File IDataViewerCollection.hpp

Inheritance Relationships

Derived Type

• public Microsoft::Applications::Events::NullDataViewerCollection (Class NullDataViewerCollection)

Class Documentation

class Microsoft::Applications::Events::IDataViewerCollection

This interface allows SDK users to register a data viewer that will receive all packets uploaded by the SDK.

Subclassed by Microsoft::Applications::Events::NullDataViewerCollection

Public Functions

virtual void DispatchDataViewerEvent(const std::vector<uint8_t> &packetData) const noexcept = 0

Dispatch a Data Viewer Event to all viewers in the collection.

Parameters

packetData – Data packet to be passed to all viewers.

virtual void RegisterViewer(const std::shared_ptr<IDataViewer> &dataViewer) = 0

Register an IDataViewer with Data Viewer Collection.

Parameters

dataViewer – dataViewer to register with IDataViewerCollection.

virtual void UnregisterViewer(const char *viewerName) = 0

Unregister a IDataViewer from LogManager.

Parameters

viewerName – Unique Name to identify the viewer that should be unregistered from the IDataViewerCollection.

virtual void UnregisterAllViewers() = 0

Unregister all registered IDataViewers.

virtual bool IsViewerEnabled(const char *viewerName) const = 0

Check if the given viewer (name) is registered as a data viewer and is actively transmitting.

Parameters

viewerName – Unique Name to identify the viewer being checked.

virtual bool IsViewerEnabled() const noexcept = 0

Check if any viewers are registered and actively transmitting.

virtual bool IsViewerRegistered(const char *viewerName) const = 0

Check if the given viewer (name) is registered as a data viewer.

Parameters

viewerName – Unique Name to identify the viewer being checked.