protection_profile_cc.h File Reference

Defines C-Style ProtectionProfile functions. More...

#include <stdint.h>
#include "mip_cc/application_info_cc.h"
#include "mip_cc/common_types_cc.h"
#include "mip_cc/consent_callback_cc.h"
#include "mip_cc/dictionary_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/http_delegate_cc.h"
#include "mip_cc/mip_context_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/protection/protection_engine_cc.h"
#include "mip_cc/result_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_protection_profile
typedef mip_cc_handle *	mip_cc_protection_profile_settings

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_ProtectionProfile_AddEngine(const mip_cc_protection_profile profile
	Add a new protection engine to the profile.
	MIP_CC_API (void) MIP_CC_ReleaseProtectionProfile(mip_cc_protection_profile profile)
	Release resources associated with a protection profile.

Variables
const mip_cc_protection_engine_settings	settings
const mip_cc_protection_engine_settings mip_cc_protection_engine *	engine
const mip_cc_protection_engine_settings mip_cc_protection_engine mip_cc_error *	errorInfo
mip_cc_protection_profile *	profile
const mip_cc_cache_storage_type	cacheStorageType
const mip_cc_cache_storage_type const void *	reserved
const mip_cc_cache_storage_type const void const mip_cc_consent_callback	consentCallback
const char *	sessionId
const bool	canCacheLicenses
const mip_cc_http_delegate	httpDelegate
const mip_cc_task_dispatcher_delegate	taskDispatcherDelegate
const mip_cc_dictionary	customSettings

Detailed Description

Defines C-Style ProtectionProfile functions.

Typedef Documentation

mip_cc_protection_profile

typedef mip_cc_handle* mip_cc_protection_profile

mip_cc_protection_profile_settings

typedef mip_cc_handle* mip_cc_protection_profile_settings

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Add a new protection engine to the profile.

Configures custom settings, used for feature gating and testing.

Override default async task dispatcher with client's own.

Override default HTTP stack with client's own.

Configures whether or not end user licenses (EULs) will be cached locally.

Sets the session ID that can be used to correlate logs and telemetry.

Create a settings object used to create a protection profile.

Load a profile.

Parameters

profile	Parent profile under which an engine will be added
settings	Protection engine settings
engine	[Output] Newly-created protection engine instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

settings	Profile settings
profile	[Output] Newly-created protection profile instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

mipContext	Global context shared across all profiles
cacheStorageType	Storage cache configuration
reserved	Reserved for backwards compatibility - set to nullptr
consentCallback	Callback object to be used for consent, implemented by client application
settings	[Output] Newly-created settings instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

settings	Profile settings
sessionId	Session ID that represents the lifetime of a protection profile
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

settings	Profile settings
canCacheLicenses	Whether or not engine should cache a license when opening protected content
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

settings	Profile settings to which HTTP delegate will be assigned
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

Parameters

settings	Profile settings to which task dispatcher delegate will be assigned
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

settings	Profile settings
customSettings	Key/value pairs of custom settings
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.

Release resources associated with a protection profile settings.

Parameters

profile	Protection profile to be released
settings	Protection profile settings to be released

Variable Documentation

cacheStorageType

const mip_cc_cache_storage_type cacheStorageType

canCacheLicenses

const bool canCacheLicenses

consentCallback

const mip_cc_cache_storage_type const void const mip_cc_consent_callback consentCallback

customSettings

const mip_cc_dictionary customSettings

engine

const mip_cc_protection_engine_settings mip_cc_protection_engine* engine

errorInfo

const mip_cc_dictionary mip_cc_error* errorInfo

httpDelegate

const mip_cc_http_delegate httpDelegate

profile

mip_cc_protection_profile* profile

reserved

const mip_cc_cache_storage_type const void* reserved

sessionId

const char* sessionId

settings

const mip_cc_cache_storage_type const void const mip_cc_consent_callback mip_cc_protection_profile_settings* settings

taskDispatcherDelegate

const mip_cc_task_dispatcher_delegate taskDispatcherDelegate