mip_context_cc.h File Reference

Defines C-Style MipContext functions. More...

#include <stdint.h>
#include "mip_cc/application_info_cc.h"
#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/flighting_feature_cc.h"
#include "mip_cc/logger_delegate_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/result_cc.h"
#include "mip_cc/telemetry_configuration_cc.h"

Include dependency graph for mip_context_cc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	mip_cc_feature_override
	Defines a single feature's enabled/disabled state. More...

Typedefs
typedef mip_cc_handle *	mip_cc_mip_context

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_CreateMipContext(const mip_cc_application_info *applicationInfo
	Create a MIP context to manage state shared across all profile instances.
	MIP_CC_API (void) MIP_CC_ReleaseMipContext(mip_cc_mip_context mipContext)
	Release resources associated with a MIP context.

Variables
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration	diagnosticOverride
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration mip_cc_mip_context mip_cc_error *	errorInfo
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override *	featureSettings
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override const int64_t	featureSettingsSize
const char const mip_cc_log_level const bool	isOfflineOnly
const char const mip_cc_log_level const bool const mip_cc_logger_delegate	loggerDelegateOverride
const char const mip_cc_log_level	logLevel
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration mip_cc_mip_context *	mipContext
const char *	path

Detailed Description

Defines C-Style MipContext functions.

Definition in file mip_context_cc.h.

Typedef Documentation

mip_cc_mip_context

typedef mip_cc_handle* mip_cc_mip_context

Definition at line 48 of file mip_context_cc.h.

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Create a MIP context to manage state shared across all profile instances.

Parameters

applicationInfo	Info about application that is consuming the protection SDK
path	File path under which logging, telemetry, and other protection collateral is stored
logLevel	Minimum log level for .miplog
isOfflineOnly	Enable/disable network operations (not all actions supported when offline)
loggerDelegateOverride	(Optional) Logger override implementation
diagnosticOverride	(Optional) Overridden telemetry settings. If NULL, default settings will be used
mipContext	[Output] Newly-created MIP context instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

applicationInfo	Info about application that is consuming the protection SDK
path	File path under which logging, telemetry, and other protection collateral is stored
logLevel	Minimum log level for .miplog
isOfflineOnly	Enable/disable network operations (not all actions supported when offline)
loggerDelegateOverride	(Optional) Logger override implementation
diagnosticOverride	(Optional) Overridden telemetry settings. If NULL, default settings will be used
featureSettings	(Optional) Array of custom feature overrides
featureSettingsSize	Size of custom feature overrides (in # of overrides)
mipContext	[Output] Newly-created MIP context instance
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 MIP context.

Parameters

mipContext

MIP context to be released

Variable Documentation

diagnosticOverride

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration diagnosticOverride

Definition at line 78 of file mip_context_cc.h.

errorInfo

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override const int64_t mip_cc_mip_context mip_cc_error* errorInfo

Definition at line 80 of file mip_context_cc.h.

featureSettings

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override* featureSettings

Definition at line 105 of file mip_context_cc.h.

featureSettingsSize

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override const int64_t featureSettingsSize

Definition at line 106 of file mip_context_cc.h.

isOfflineOnly

const char const mip_cc_log_level const bool isOfflineOnly

Definition at line 76 of file mip_context_cc.h.

loggerDelegateOverride

const char const mip_cc_log_level const bool const mip_cc_logger_delegate loggerDelegateOverride

Definition at line 77 of file mip_context_cc.h.

logLevel

const char const mip_cc_log_level logLevel

Definition at line 75 of file mip_context_cc.h.

mipContext

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override const int64_t mip_cc_mip_context * mipContext

Definition at line 79 of file mip_context_cc.h.

path

const char * path

Definition at line 74 of file mip_context_cc.h.