Class NullLogManager

Defined in File NullObjects.hpp

Inheritance Relationships

Base Type

public Microsoft::Applications::Events::ILogManager (Class ILogManager)

Class Documentation

class Microsoft::Applications::Events::NullLogManager : public Microsoft::Applications::Events::ILogManager 

Public Functions

inline NullLogManager()

inline virtual bool DispatchEvent(DebugEvent) override

Dispatches event to this ILogManager instance.

Parameters: evt – DebugEvent
Returns

inline virtual void Configure() override

inline virtual void FlushAndTeardown() override: Flushes any pending telemetry events in memory to disk, and tears-down the telemetry logging system.

inline virtual status_t Flush() override

Flushes any pending telemetry events in memory to disk, to reduce possible data loss.

This method can be expensive, so you should use it sparingly. The operating system blocks the calling thread and might flush the global file buffers (all buffered file system data) to disk, which can be time consuming.

inline virtual status_t UploadNow() override: Attempts to send any pending telemetry events that are currently cached either in memory, or on disk.

inline virtual status_t PauseTransmission() override

Pauses the transmission of events to the data collector.

While paused, events continue to be queued on the client, cached either in memory or on disk.

inline virtual status_t ResumeTransmission() override: Resumes the transmission of events to the data collector.

inline virtual status_t SetTransmitProfile(TransmitProfile profile) override

Sets the transmit profile for event transmission - to one of the built-in profiles.

A transmit profile is a collection of hardware and system settings (like network connectivity, power state) based on which to determine how events are to be transmitted.

Parameters: profile – Transmit profile, as one of the ::TransmitProfile enumeration values.
Returns: This method doesn’t return a value - because it always succeeds.

inline virtual status_t SetTransmitProfile(const std::string &profile) override

Sets the transmit profile for event transmission.

A transmit profile is a collection of hardware and system settings (like network connectivity, power state, etc.).

Parameters: profile – A string that contains the transmit profile.
Returns: A boolean value that indicates success (true) or failure (false).

inline virtual status_t LoadTransmitProfiles(const std::string &profiles_json) override

Loads transmit profiles formatted in JSON.

Parameters: profiles_json – A string that contains the transmit profiles in JSON.
Returns: A boolean value that indicates success (true) or failure (false) if the configuration is invalid.

inline virtual status_t LoadTransmitProfiles(const std::vector<TransmitProfileRules> &profiles) noexcept override

Loads transmit profiles.

Parameters: profiles – A collection of transmit profiles
Returns: A boolean value that indicates success (true) or failure (false) if the configuration is invalid.

inline virtual status_t ResetTransmitProfiles() override: Resets transmission profiles to default settings.

inline virtual ILogConfiguration &GetLogConfiguration() override: Retrieves the current LogManager instance configuration

inline virtual const std::string &GetTransmitProfileName() override: Gets the name of the current transmit profile.

inline virtual ISemanticContext &GetSemanticContext() override

Retrieve an ISemanticContext interface through which to specify context information such as device, system, hardware and user information.

Context information set via this API will apply to all logger instance unless they are overwritten by individual logger instance.

Returns: ISemanticContext interface pointer

inline virtual status_t SetContext(std::string const&, std::string const&, PiiKind = PiiKind_None) override

Adds or = 0s a property of the custom context for the telemetry logging system.

Context information set here applies to events generated by all ILogger instances unless it is overwritten on a particular ILogger instance.

Parameters

name – Name of the context property
value – String value of the context property
piiKind – PIIKind of the context with PiiKind_None as the default

inline virtual status_t SetContext(const std::string&, const char*, PiiKind = PiiKind_None) override

Adds or = 0s a property of the custom context for the telemetry logging system.

Context information set here applies to events generated by all ILogger instances unless it is overwritten on a particular ILogger instance.

Parameters

name – Name of the context property
value – Value of the context property
piiKind – PIIKind of the context with PiiKind_None as the default

inline virtual status_t SetContext(const std::string&, double, PiiKind = PiiKind_None) override