policy_profile_cc.h File Reference

Contains C API definitions for policy profile. More...

#include <stdint.h>
#include "mip_cc/application_info_cc.h"
#include "mip_cc/auth_callback_cc.h"
#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/mip_context_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/result_cc.h"
#include "mip_cc/task_dispatcher_delegate_cc.h"
#include "mip_cc/upe/policy_engine_cc.h"

Include dependency graph for policy_profile_cc.h:

Go to the source code of this file.

Typedefs
typedef mip_cc_handle *	mip_cc_policy_profile
typedef mip_cc_handle *	mip_cc_policy_profile_settings

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_PolicyProfile_AddEngine(const mip_cc_policy_profile profile
	Add a new policy engine to the profile.
	MIP_CC_API (void) MIP_CC_ReleasePolicyProfile(mip_cc_policy_profile profile)
	Release resources associated with a policy profile.

Variables
const mip_cc_cloud const mip_cc_auth_callback	authCallback
const mip_cc_cache_storage_type	cacheStorageType
const mip_cc_cloud	cloud
const mip_cc_policy_engine_settings const void *	context
const mip_cc_dictionary	customSettings
const mip_cc_policy_engine_settings const void mip_cc_policy_engine *	engine
const mip_cc_policy_engine_settings const void mip_cc_policy_engine mip_cc_error *	errorInfo
const mip_cc_http_delegate	httpDelegate
mip_cc_policy_profile *	profile
const mip_cc_cache_storage_type const void *	reserved
const char *	sessionId
const mip_cc_policy_engine_settings	settings
const mip_cc_task_dispatcher_delegate	taskDispatcherDelegate

Detailed Description

Contains C API definitions for policy profile.

Definition in file policy_profile_cc.h.

Typedef Documentation

mip_cc_policy_profile

typedef mip_cc_handle* mip_cc_policy_profile

Definition at line 51 of file policy_profile_cc.h.

mip_cc_policy_profile_settings

typedef mip_cc_handle* mip_cc_policy_profile_settings

Definition at line 52 of file policy_profile_cc.h.

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Add a new policy 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.

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

Create a settings object used to create a policy profile.

Load a profile.

Trigger an authentication callback.

Parameters

profile	Parent profile under which an engine will be added
settings	Policy engine settings
context	Client context that will be opaquely passed to HttpDelegate and AuthDelegate
engine	[Output] Newly-created policy engine instance
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

profile	Profile
cloud	Azure cloud
authCallback	Authentication callback that will be invoked
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

MIP will not cache or do anything else with the value returned by the auth delegate. This function is recommended for applications that aren't "logged in" until after MIP requests an auth token. It allows an application to fetch a token before MIP actually requires one.

Parameters

settings	Profile settings
profile	[Output] Newly-created policy 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
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 policy profile
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 policy profile.

Release resources associated with a policy profile settings.

Parameters

profile	Policy profile to be released
settings	Policy profile settings to be released

Variable Documentation

authCallback

const mip_cc_cloud const mip_cc_auth_callback authCallback

Definition at line 89 of file policy_profile_cc.h.

cacheStorageType

const mip_cc_cache_storage_type cacheStorageType

Definition at line 126 of file policy_profile_cc.h.

cloud

const mip_cc_cloud cloud

Definition at line 88 of file policy_profile_cc.h.

context

const mip_cc_policy_engine_settings const void* context

Definition at line 68 of file policy_profile_cc.h.

customSettings

const mip_cc_dictionary customSettings

Definition at line 184 of file policy_profile_cc.h.

engine

const mip_cc_policy_engine_settings const void mip_cc_policy_engine* engine

Definition at line 69 of file policy_profile_cc.h.

errorInfo

const mip_cc_dictionary mip_cc_error* errorInfo

Definition at line 70 of file policy_profile_cc.h.

httpDelegate

const mip_cc_http_delegate httpDelegate

Definition at line 156 of file policy_profile_cc.h.

profile

mip_cc_policy_profile* profile

Definition at line 103 of file policy_profile_cc.h.

reserved

const mip_cc_cache_storage_type const void* reserved

Definition at line 127 of file policy_profile_cc.h.

sessionId

const char* sessionId

Definition at line 142 of file policy_profile_cc.h.

settings

const mip_cc_cache_storage_type const void mip_cc_policy_profile_settings* settings

Definition at line 67 of file policy_profile_cc.h.

taskDispatcherDelegate

const mip_cc_task_dispatcher_delegate taskDispatcherDelegate

Definition at line 170 of file policy_profile_cc.h.