telemetry_configuration_cc.h File Reference

Defines custom telemetry settings. More...

#include <memory>
#include "mip_cc/common_types_cc.h"
#include "mip_cc/dictionary_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/http_delegate_cc.h"
#include "mip_cc/task_dispatcher_delegate_cc.h"

Go to the source code of this file.

Typedefs
typedef mip_cc_handle *	mip_cc_telemetry_configuration

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_CreateTelemetryConfiguration(mip_cc_telemetry_configuration *telemetryConfig
	Create a settings object used to create a protection profile.
	MIP_CC_API (void) MIP_CC_ReleaseTelemetryConfiguration(mip_cc_telemetry_configuration telemetryConfig)
	Release resources associated with a protection profile settings.

Variables
mip_cc_error *	errorInfo
const char *	hostName
const char *	libraryName
const mip_cc_http_delegate	httpDelegate
const mip_cc_task_dispatcher_delegate	taskDispatcherDelegate
const bool	isNetworkDetectionEnabled
const bool	isCachingEnabled
const bool	isTraceLoggingEnabled
const bool	isMinimalTelemetryEnabled
const bool	isFastShutdownEnabled
const mip_cc_dictionary	customSettings
const char *	eventName
const char const char *	propertyName

Detailed Description

Defines custom telemetry settings.

Typedef Documentation

mip_cc_telemetry_configuration

typedef mip_cc_handle* mip_cc_telemetry_configuration

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

Create a settings object used to create a protection profile.

Sets a telemetry property to mask.

Sets custom telemetry settings.

Sets whether fast telemetry shutdown is enabled or not.

Sets whether or not an application/user has opted out of optional telemetry.

Sets whether or not the telemetry component is allowed to write logs to disk.

Sets whether or not the telemetry component is allowed to write caches to disk.

Sets whether or not the telemetry component is allowed ping network status on a background thread.

Override default async task dispatcher with client's own.

Override default telemetry HTTP stack with client's own.

Set a telemetry shared library override.

Set a telemetry host name which will override internal telemetry settings.

Parameters

telemetryConfig	[Output] Newly-created telemetry configuration instance containing default settings
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

telemetryConfig	Telemetry configuration
hostName	Host name
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

This property is set when a client application uses the same Aria/1DS telemetry component and wishes for its internal telemetry settings (caching, logging, priority etc.) to be used instead of MIP's default settings

Parameters

telemetryConfig	Telemetry configuration
libraryName	Name of DLL that implements the Aria/1DS SDK's C API
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

This property is set when a client has an existing telemetry DLL that implements the Aria/1DS SDK's C API that should be used instead of mip_ClientTelemetry.dll

Parameters

telemetryConfig	Telemetry configuration
httpDelegate	HTTP callback instance implemented by client application
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If this property is not set, the telemetry component will use MIP's default HTTP stack

Parameters

telemetryConfig	Telemetry configuration
taskDispatcherDelegate	Task dispatcher callback instance implemented by client application
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

telemetryConfig	Telemetry configuration
isCachingEnabled	Whether or not the telemetry component is allowed ping network status on a background thread
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

Default is 'true'

Parameters

telemetryConfig	Telemetry configuration
isCachingEnabled	Whether or not the telemetry component is allowed to write caches to disk
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

Default is 'true'

Parameters

telemetryConfig	Telemetry configuration
isTraceLoggingEnabled	Whether or not the telemetry component is allowed to write logs to disk. These files can grow to be very large, and may require manual cleanup from the host application.
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

Default is 'true'

Parameters

telemetryConfig	Telemetry configuration
isMinimalTelemetryEnabled	Whether or not an application/user has opted out of optional telemetry
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

Default is 'false'

Parameters

telemetryConfig	Telemetry configuration
isFastShutdownEnabled	Whether or not the telemetry fast shutdown is enabled
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

Default is 'false'

Parameters

telemetryConfig	Telemetry configuration
customSettings	Custom telemetry settings
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

telemetryConfig	Telemetry configuration
eventName	Event name
propertyName	Property name
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with a protection profile settings.

Parameters

profileSettings

Protection profile settings to be released

Variable Documentation

customSettings

const mip_cc_dictionary customSettings

errorInfo

const mip_cc_task_dispatcher_delegate mip_cc_error* errorInfo

eventName

const char* eventName

hostName

const char* hostName

httpDelegate

const mip_cc_http_delegate httpDelegate

isCachingEnabled

const bool isCachingEnabled

isFastShutdownEnabled

const bool isFastShutdownEnabled

isMinimalTelemetryEnabled

const bool isMinimalTelemetryEnabled

isNetworkDetectionEnabled

const bool isNetworkDetectionEnabled

isTraceLoggingEnabled

const bool isTraceLoggingEnabled

libraryName

const char* libraryName

propertyName

const char const char* propertyName

taskDispatcherDelegate

const mip_cc_task_dispatcher_delegate taskDispatcherDelegate